warpy.apps.phmaxwell.phmaxwell.cyl_source Class Reference

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

Inheritance diagram for warpy.apps.phmaxwell.phmaxwell.cyl_source:

Detailed Description

source terms required for modeling in a cylindrical coordinate system

Parameters

name	Name of application
min_radius_equals_zero	true if minimum radius is 0 (optional; defaults to false). May be set to false if quadrature scheme (such as Gaussian quadrature) is used such that sources are not computed at r=0.
radial_index	index 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.
omega_p_norm	Normalized proton plasma frequency
skin_depth_norm	Normalized skin depth
field	Field variable
fluid_gradient	Fluid gradient variable. Note that the fluid gradient variable must be present. However, if min_radius_equals_zero is false, the gradient variable may be a dummy variable, i.e., initialized, but not computed. There should be no significant computational expense to create and pass such a variable. The need for such a dummy variable could be eliminated if optional variable passing were possible.
field_components	Components of field variable
field_gradient_components	Components of field variable

Public Member Functions
def	__init__ (self, name, omega_p_norm, skin_depth_norm, chi, gamma, field, field_gradient, radial_index=0, min_radius_equals_zero=False, field_components=None, field_gradient_components=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.phmaxwell.phmaxwell.cyl_source.__init__	(		self,
			name,
			req_attrs,
			opt_attrs,
			variables,
			const_variables,
			sub_applications,
			field_gradient,
			radial_index = 0,
			min_radius_equals_zero = False,
			field_components = None,
			field_gradient_components = None
	)

Parameters

name
req_attrs
opt_attrs
variables	list of tuples of (arg_name, variable, components) which might be non-const.
const_variables	list 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:

• tools/warpy/apps/phmaxwell/phmaxwell.py