FELiCS.Fields.fieldProperties

FELiCS.Fields.fieldProperties#

Module Contents#

Classes#

fieldProperties

Provides property decorators for accessing and transforming field quantities.

Attributes#

logger

FELiCS.Fields.fieldProperties.logger#
class FELiCS.Fields.fieldProperties.fieldProperties#

Provides property decorators for accessing and transforming field quantities.

This class defines a set of property methods and accessors for field variables, enabling consistent access to physical quantities (e.g., velocity, pressure, temperature) from the internal field dictionary. It is designed to be used as a mixin for classes such as fluctuationClass, fluctuationSolution, meanFlowClass, and meanFlowVertexValues.

Initialize the fieldProperties object

Variables:

  • _fieldDict (dict) – Dictionary containing all field variables for the current object.

  • _zeroField (object) – Default fallback field for missing scalar quantities.

  • _oneField (object) – Default fallback field with all coefficients set to one.

  • _zeroVectorField (object) – Default fallback field for missing velocity quantities.

  • _mean (object) – Reference to the mean flow object, if available.

  • _FEMSpaces (object) – Finite element spaces, used for projections.

  • _coordinateSystem (object) – Coordinate system information for tensor operations.

  • __hSpec (dict) – Additional species enthalpy information, if present.

  • __reaction (object) – Reaction information, if present.

  • _param (object) – Simulation parameter object, if present.

  • _mesh (object) – Mesh object, if present.

  • _fluc (object) – Fluctuation field object, if present.

  • _ScalarFunctionSpace (object) – Scalar function space for field projections.

  • _meanflowFilename (str) – Filename for the mean flow data, if present.

  • _transportedQuantities (list of str) – List of transported quantity names, if present.

  • alpha (object) – Field variable for alpha (e.g., thermal diffusivity or similar).

  • cp (object) – Field variable for specific heat at constant pressure.

  • dQ (object) – Field variable for heat release rate.

  • fieldDict (dict) – Dictionary of all field variables, with special handling for mean flow classes.

  • FieldNames (list of str) – List of field variable names.

  • fluc (object) – Fluctuation field object.

  • forcingDomain (object) – Field variable for the domain where forcing is applied.

  • gamma (object) – Field variable for heat capacity ratio.

  • Pr (object) – Field variable for Prandtl number.

  • UnitT (object) – Real unit number in tensor form.

  • h (object) – Field variable for enthalpy.

  • he (object) – Field variable for total enthalpy.

  • hSpec (dict) – Dictionary of species enthalpy fields.

  • meanflowFilename (str) – Filename for the mean flow data.

  • molarMass (object) – Field variable for molar mass.

  • nulam (object) – Field variable for laminar viscosity.

  • nuTot (object) – Field variable for total viscosity (laminar + turbulent + SGS).

  • p (object) – Field variable for pressure.

  • RR_prefactor (object) – Field variable for reaction rate prefactor.

  • Q (object) – Field variable for total heat release.

  • R_spe (object) – Field variable for specific gas constant.

  • reaction (object) – Reaction object.

  • spg (object) – Field variable for sponge region term.

  • rho (object) – Field variable for density.

  • rhou (object) – Field variable for momentum (density * velocity).

  • T (object) – Field variable for temperature.

  • tau (object) – Field variable for stress tensor.

  • Tb (object) – Field variable for burnt temperature.

  • Tu (object) – Field variable for unburnt temperature.

  • responseDomain (object) – Field variable for the response domain mask.

  • u (object) – Field variable for velocity.

  • u_forcing_i (object) – Field variable for imaginary part of velocity forcing.

  • u_forcing_r (object) – Field variable for real part of velocity forcing.

  • u_forcing (object) – Field variable for complex velocity forcing.

  • ut (object) – Field variable for transverse velocity component.

Notes

This class is not intended to be instantiated directly, but to be inherited by classes that manage field data for mean or fluctuating flow quantities.

property alpha#

Get the alpha field variable, with fallback for missing data.

Returns:

Alpha field as tensor or fallback field.

Return type:

object

property c#
property cp#

Get the specific heat at constant pressure.

Returns:

Field variable for cp.

Return type:

object

property dQ#

Get the heat release rate field variable.

Returns:

Field variable for heat release rate.

Return type:

object

property fieldDict#

Get the dictionary of all field variables, with special handling for mean flow classes.

Returns:

Dictionary of field variables.

Return type:

dict

property FieldNames#

Get the list of field variable names.

Returns:

List of field variable names.

Return type:

list of str

property fluc#

Get the fluctuation field object.

Returns:

Fluctuation field object.

Return type:

object

property forcingDomain#

Get the field variable for the domain where forcing is applied.

Returns:

Field variable for the forcing domain.

Return type:

object

property gamma#

Get the heat capacity ratio (gamma).

Returns:

Field variable for heat capacity ratio.

Return type:

object

property Pr#

Get the Prandtl number field variable.

Returns:

Field variable for Prandtl number.

Return type:

object

property UnitT#

Get the real unit number in tensor form.

Returns:

Tensor representing the real unit number.

Return type:

object

property h#

Get the enthalpy field variable.

Returns:

Field variable for enthalpy.

Return type:

object

property he#

Get the total enthalpy field variable.

Returns:

Field variable for total enthalpy.

Return type:

object

property hSpec#

Get the dictionary of species enthalpy fields.

Returns:

Dictionary of species enthalpy fields.

Return type:

dict

property meanflowFilename#

Get the filename for the mean flow data.

Returns:

Filename for the mean flow data.

Return type:

str

property molarMass#

Get the molar mass field variable.

Returns:

Field variable for molar mass.

Return type:

object

property nulam#

Get the laminar viscosity field variable.

Returns:

Field variable for laminar viscosity.

Return type:

object

property nuTot#

Get the total viscosity field variable (laminar + turbulent + SGS).

Returns:

Field variable for total viscosity.

Return type:

object

property p#

Get the pressure field variable, with fallback for missing data.

Returns:

Field variable for pressure.

Return type:

object

property phi#
property RR_prefactor#

Get the reaction rate prefactor field variable.

Returns:

Field variable for reaction rate prefactor.

Return type:

object

property Q#

Get the total heat release field variable.

Returns:

Field variable for total heat release.

Return type:

object

property R_spe#

Get the specific gas constant field variable.

Returns:

Field variable for specific gas constant.

Return type:

object

property reaction#

Get the reaction object.

Returns:

Reaction object.

Return type:

object

property spg#

Get the sponge region term field variable.

Returns:

Field variable for sponge region term.

Return type:

object

property rho#

Get the density field variable, with fallback for missing data.

Returns:

Field variable for density.

Return type:

object

property rhou#

Get the momentum field variable (density * velocity).

Returns:

Field variable for momentum.

Return type:

object

property T#

Get the temperature field variable, with fallback for missing data.

Returns:

Field variable for temperature.

Return type:

object

property tau#

Get the stress tensor field variable.

Returns:

Field variable for stress tensor.

Return type:

object

property Tb#

Get the burnt temperature field variable.

Returns:

Field variable for burnt temperature.

Return type:

object

property Tu#

Get the unburnt temperature field variable.

Returns:

Field variable for unburnt temperature.

Return type:

object

property Tm#
property responseDomain#

Get the response domain mask field variable.

Returns:

Field variable for response domain mask.

Return type:

object

property u#

Get the velocity field variable, with fallback for missing data.

Returns:

Field variable for velocity.

Return type:

object

property u_forcing_i#

Get the imaginary part of the velocity forcing field variable.

Returns:

Field variable for imaginary part of velocity forcing.

Return type:

object

property u_forcing_r#

Get the real part of the velocity forcing field variable.

Returns:

Field variable for real part of velocity forcing.

Return type:

object

property u_forcing#

Get the complex velocity forcing field variable.

Returns:

Field variable for complex velocity forcing.

Return type:

object

property ut#

Deprecated variable must be deleted Get the transverse velocity component field variable.

Returns:

Field variable for transverse velocity component.

Return type:

object

Type:

TODO

isMeanFlowClass()#

Check if the current object is an instance of meanFlowClass.

Returns:

True if the object is a meanFlowClass instance, False otherwise.

Return type:

bool

isMeanFlowVertexValuesClass()#

Check if the current object is an instance of meanFlowVertexValues.

Returns:

True if the object is a meanFlowVertexValues instance, False otherwise.

Return type:

bool

D(specie)#

Get the diffusion coefficient for a given species.

Parameters:

specie (str) – Name of the species.

Returns:

Diffusion coefficient field for the species.

Return type:

object

forcing_i(solution)#

Get the imaginary part of the forcing field for a given solution variable.

Parameters:

solution (str) – Name of the solution variable.

Returns:

Imaginary part of the forcing field.

Return type:

object

forcing_r(solution)#

Get the real part of the forcing field for a given solution variable.

Parameters:

solution (str) – Name of the solution variable.

Returns:

Real part of the forcing field.

Return type:

object

forcing(solution)#

Get the complex forcing field for a given solution variable.

Parameters:

solution (str) – Name of the solution variable.

Returns:

Complex forcing field as a tensor.

Return type:

object

rhoY(species)#

Get the product of density and species mass fraction.

Parameters:

species (str) – Name of the species.

Returns:

Field variable for rho * Y(species).

Return type:

object

Y(specie)#

Get the mass fraction field variable for a given species.

Parameters:

specie (str) – Name of the species.

Returns:

Field variable for species mass fraction.

Return type:

object

Contents