warpy.variable.unique_variable Class Reference

Inheritance diagram for warpy.variable.unique_variable:

Detailed Description

See also

Unique Variable

Public Member Functions
def	__init__ (self, name, components, explodable=True, subdomains=None, virtual_subdomains=None)
def	components (self, with_varname=False, stage=None, others=None)
	Gets the list of components in this variable.
def	name (self, stage=None)
	Gets the name of this variable.
def	__repr__ (self)
	Give variables a readable string representation.

Public Attributes
	subdomains
	explodable

Constructor & Destructor Documentation

__init__()

def warpy.variable.unique_variable.__init__	(		self,
			name,
			components,
			explodable = True,
			subdomains = None,
			virtual_subdomains = None
	)

Parameters

name	variable name
components	list of components in this variable
explodable	True to explode this variable with RK stages
BasisArraySet	DG Basis array set name
subdomains	physical subdomains this variable exists on
virtual_subdomains	subdomains this variable is allocated for, but doesn't physically exist on

Member Function Documentation

__repr__()

def warpy.variable.unique_variable.__repr__

(

self

)

Give variables a readable string representation.

For use in debugging.

components()

def warpy.variable.unique_variable.components	(		self,
			with_varname = False,
			stage = None,
			others = None
	)

Gets the list of components in this variable.

Parameters

with_varname	True to prepend variable name
stage	what stage to use for

name()

def warpy.variable.unique_variable.name	(		self,
			stage = None
	)

Gets the name of this variable.

Parameters

stage

None to get the base name, else a number to get the exploded RK stage name

Member Data Documentation

explodable

warpy.variable.unique_variable.explodable

subdomains

warpy.variable.unique_variable.subdomains

---

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

• tools/warpy/variable.py