pg_utils.pg_model.expansion.ExpansionRecipe

class pg_utils.pg_model.expansion.ExpansionRecipe(identifier: str, fourier_expand: FourierExpansions, rad_expand: RadialExpansions, rad_test: RadialTestFunctions, inner_prod_op: RadialInnerProducts, base_expr: Optional[LabeledCollection] = None, test_expr: Optional[LabeledCollection] = None)

Bases: object

The top-level class used for spectral expansion, which defines the recipe concerning radial and azimuthal expansions.

Variables:

• identifier (str) – name of the expansion

• fourier_xpd (FourierExpansion) – defines the fourier expansion part this is considered shared among all fields

• rad_xpd (RadialExpansion) – defines the radial expansion

• rad_test (RadialTestFunctions) – test functions for each radial equation

• inner_prod_op (RadialInnerProducts) – inner products associated with each eq

• base_expr (dict) – explicit expressions of the bases for substitution

• test_expr (dict) – explicit expressions of the test functions for substitution

__init__(identifier: str, fourier_expand: FourierExpansions, rad_expand: RadialExpansions, rad_test: RadialTestFunctions, inner_prod_op: RadialInnerProducts, base_expr: Optional[LabeledCollection] = None, test_expr: Optional[LabeledCollection] = None) → None

Initialization

Parameters:

• fourier_expand (FourierExpansion) – defines the fourier expansion part which is considered shared among all fields

• rad_expand (RadialExpansion) – defines the radial expansion

• rad_test (RadialTestFunctions) – test functions for each radial equation

• inner_prod_op (RadialInnerProducts) – inner products associated with each eq

• base_expr (Optional[base.LabeledCollection]) – explicit expression of the bases (if rad_expand uses placeholders)

• test_expr (Optional[base.LabeledCollection]) – explicit expression of the test functions (if rad_test uses placeholders)

Methods

__init__(identifier, fourier_expand, ...[, ...])

Initialization