WARPXM v1.10.0
Loading...
Searching...
No Matches
warpy.apps.mhd.rmhd.rmhd.cyl_source Class Reference

source terms required for modeling in a cylindrical coordinate system More...

Inheritance diagram for warpy.apps.mhd.rmhd.rmhd.cyl_source:
warpy.apps.application.application warpy.apps.application.applications_container

Detailed Description

source terms required for modeling in a cylindrical coordinate system

Parameters
nameName of application
gammaGas Gamma (Adiabatic Index)
skin_depth_normnormalized skin depth
nu_p_normnormalized collision frequency
omega_p_normnormalized plasma frequency needed if using chodura resistivity May be set to false if quadrature scheme (such as Gaussian quadrature) is used such that sources are not computed at r=0.
radial_indexindex of radial component (optional; defaults to 0) To configure the coordinate systems as [r,theta,z] or [z,r,theta], set this variable to either 0 or 1, respectively.
fluidFluid variable
fluid_gradientFluid gradient variable. Note that the fluid gradient variable must be present.
fluid_componentsComponents of fluid variable
gradient_componentsComponents of fluid gradient variable.

Public Member Functions

def __init__ (self, name, gamma, skin_depth_norm, nu_p_norm, fluid, fluid_gradient, omega_p_norm=None, mass=None, charge=None, ln_lambda=None, resistivity_type=None, resistivity=None, floor_density=None, floor_pressure=None, max_eta=None, min_eta=None, n_vac=None, eta_vac=None, radial_index=0, fluid_components=None, gradient_components=None, floor_sub_app=None)
 
- Public Member Functions inherited from warpy.apps.application.application
def __init__ (self, name, req_attrs, opt_attrs=None, variables=None, const_variables=None, sub_applications=None)
 
def map_components (self, comp_map)
 
def variables (self)
 
def const_variables (self)
 
def components (self)
 
def const_components (self)
 
def attrs (self, stage=None)
 
- Public Member Functions inherited from warpy.apps.application.applications_container
def __init__ (self, name, applications, req_attrs, opt_attrs=None, extra_components=None, extra_const_components=None)
 
def convert_variable_to_components_list (self, variable, variable_components=None)
 
def convert_variables_to_components_list (self, variables, variables_components=None)
 
def convert_components_to_indexes (self, comps_list)
 
def internal_components (self)
 
def internal_const_components (self)
 
def map_components (self, comp_map)
 
def generate (self, start=None, stop=None, stride=1, explode_name=True, explode_args=True)
 generates a list of blocks representing this pywarp object
 

Additional Inherited Members

- Public Attributes inherited from warpy.apps.application.application
 vars_
 
 const_vars_
 
 components_
 
 const_components_
 
 component_map
 
- Public Attributes inherited from warpy.apps.application.applications_container
 component_map
 
 applications
 
 int_components_
 
 int_const_components_
 

Constructor & Destructor Documentation

◆ __init__()

def warpy.apps.mhd.rmhd.rmhd.cyl_source.__init__ (   self,
  name,
  req_attrs,
  opt_attrs,
  variables,
  const_variables,
  sub_applications,
  omega_p_norm = None,
  mass = None,
  charge = None,
  ln_lambda = None,
  resistivity_type = None,
  resistivity = None,
  floor_density = None,
  floor_pressure = None,
  max_eta = None,
  min_eta = None,
  n_vac = None,
  eta_vac = None,
  radial_index = 0,
  fluid_components = None,
  gradient_components = None,
  floor_sub_app = None 
)
Parameters
name
req_attrs
opt_attrs
variableslist of tuples of (arg_name, variable, components) which might be non-const.
const_variableslist of tuples of (arg_name, variable, components) which are definitely const.

Reimplemented from warpy.apps.application.application.


The documentation for this class was generated from the following file: