WARPXM v1.10.0
Loading...
Searching...
No Matches
warpy.apps.five_moment.five_moment.sheath_bc Class Reference

sheath BC for electron-ion-neutral model More...

Inheritance diagram for warpy.apps.five_moment.five_moment.sheath_bc:
warpy.apps.application.application warpy.apps.application.applications_container

Detailed Description

sheath BC for electron-ion-neutral model

Parameters
nameName of application
bc_typeType of sheath BC to be set
var_typeType of variable (electron, ion, neutral, field)
paramsSpecial parameters for the BC; an array of reals with max length 10
on_boundariesBoundaries to which BC is applied
varVariable to be set
componentsComponents of variable
fluid_aux1Auxiliary ion fluid
fluid_aux1_componentsComponents of auxiliary ion fluid
fluid_aux2Auxiliary electron fluid
fluid_aux2_componentsComponents of auxiliary electron fluid
fluid_aux3Auxiliary neutral fluid
fluid_aux3_componentsComponents of auxiliary neutral fluid

Public Member Functions

def __init__ (self, name, bc_type, var_type, on_boundaries, var, fluid_aux1, fluid_aux2, fluid_aux3, params=None, var_components=None, fluid_aux1_components=None, fluid_aux2_components=None, fluid_aux3_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.five_moment.five_moment.sheath_bc.__init__ (   self,
  name,
  req_attrs,
  opt_attrs,
  variables,
  const_variables,
  sub_applications,
  fluid_aux2,
  fluid_aux3,
  params = None,
  var_components = None,
  fluid_aux1_components = None,
  fluid_aux2_components = None,
  fluid_aux3_components = 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: