warpy.functions.applicator.applicator Class Reference

Initial condition applicator. More...

Inheritance diagram for warpy.functions.applicator.applicator:

Detailed Description

Initial condition applicator.

Public Member Functions
def	__init__ (self, spatial_order, fun, var, components=None, spatial_scheme='Nodal', stage=0, v_space_num_elements=None, phase_space_spatial_order=None, min_v=None, dv=None)
def	variables (self)

Static Public Member Functions
def	gen_write_vars (var, components=None, stage=None)

Public Attributes
	fun
	variable

Static Public Attributes
int	idx = 0
dict	spatial_order_types

Constructor & Destructor Documentation

__init__()

def warpy.functions.applicator.applicator.__init__	(		self,
			spatial_order,
			fun,
			var,
			components = None,
			spatial_scheme = 'Nodal',
			stage = 0,
			v_space_num_elements = None,
			phase_space_spatial_order = None,
			min_v = None,
			dv = None
	)

Parameters

spatial_order	For FiniteVolume this is an integer. For Nodal spatial schemes, this is the BasisArraySet
fun	function to run for IC
var	variable to apply this IC to
components	list of components in var this ic should be applied to or None to apply to all components.
spatial_scheme	FiniteVolume or Nodal
stage	what RK variable set to apply IC to. Default is 0. Set to None to use the raw variable name.

Member Function Documentation

gen_write_vars()

def warpy.functions.applicator.applicator.gen_write_vars (   var,   components = None,   stage = None  )

static

variables()

def warpy.functions.applicator.applicator.variables

(

self

)

Member Data Documentation

fun

warpy.functions.applicator.applicator.fun

idx

int warpy.functions.applicator.applicator.idx = 0

static

spatial_order_types

dict warpy.functions.applicator.applicator.spatial_order_types

static

Initial value:

=  {
        'FiniteVolume': 'SpatialOrder',
        'Nodal': 'BasisArraySet',
        'Nodal_Kinetic': 'BasisArraySet'
    }

variable

warpy.functions.applicator.applicator.variable

---

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

• tools/warpy/functions/applicator.py