warpy.apps.maxwell.maxwell.divergence_error Class Reference

Calculation of divergence error. More...

Inheritance diagram for warpy.apps.maxwell.maxwell.divergence_error:

Detailed Description

Calculation of divergence error.

Parameters

name	Name of module
field	Field variable
field_components	Components of field variable
divergence_error	Field variable
divergence_error_components	Components divergence error variable
fluids	Field variable
fluids_components	Components divergence error variable
skin_depth_norm	Normalized skin depth
omega_p_norm	Normalized plasma frequency
coordinate_system	Cartesian or Cylindrical coordinate system
radial_index	radial index if using Cylindrical coordinate system
min_radius_equals_zero	if using Cylindrical coordinate system (boolean) for min radius == 0

Public Member Functions
def	__init__ (self, name, omega_p_norm, skin_depth_norm, field, field_gradient, divergence_error_variable, coordinate_system=None, radial_index=None, masses=None, charges=None, fluids=None, field_components=None, fluids_components=['rho'], field_gradient_components=None, divergence_error_variable_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.maxwell.maxwell.divergence_error.__init__	(		self,
			name,
			req_attrs,
			opt_attrs,
			variables,
			const_variables,
			sub_applications,
			coordinate_system = None,
			radial_index = None,
			masses = None,
			charges = None,
			fluids = None,
			field_components = None,
			fluids_components = ['rho'],
			field_gradient_components = None,
			divergence_error_variable_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/maxwell/maxwell.py