FELiCS.Fields.fluctuationClass

FELiCS.Fields.fluctuationClass#

Module Contents#

Classes#

fluctuationClass

Container for fluctuating variables and derived fields for postprocessing.

fluctuationSolutions

Stores and manages linearized fluctuation solutions.

Attributes#

logger

FELiCS.Fields.fluctuationClass.logger#
class FELiCS.Fields.fluctuationClass.fluctuationClass(param, mean, FEMSpaces, coordinateSystem)#

Bases: FELiCS.Fields.fieldProperties.fieldProperties, FELiCS.Equation.dependentVariables.reactionHandler.reactionHandler, FELiCS.Equation.dependentVariables.equationOfStateHandler.equationOfStateHandler, FELiCS.Equation.dependentVariables.energyHandler.energyHandler, FELiCS.Equation.dependentVariables.momentumHandler.momentumHandler

Container for fluctuating variables and derived fields for postprocessing.

This class wraps the test functions representing transported variables within the linearized governing equations. In addition to these, it also derives secondary fields (dependent variables) from the transported variables, which are needed for postprocessing and exporting results.

It plays a central role in calculating and organizing both transported and derived quantities used in numerical simulations.

Initialize the fluctuationClass object

Parameters:

  • param (FELiCSParameter) – FELiCS parameter object containing simulation configuration.

  • mean (meanFlowClass) – Mean flow object.

  • FEMSpaces (FEMSpaceHandler) – Object encapsulating FEM spaces used in the simulation.

  • coordinateSystem (object) – Representation of the simulation’s coordinate system.

Variables:

  • _fluc (ufl.argument.TrialFunction) – Trial function for the mixed finite element space.

  • _mean (meanFlowClass) – Temporal mean flow object.

  • _transportedQuantities (list of str) – Names of the transported quantities.

  • _zeroVectorField (dolfinx.Function) – Zero-valued vector function in the velocity space.

  • _fieldDict (dict) – Dictionary of calculated fields (both transported and dependent).

  • _zeroField (dolfinx.Function) – Scalar zero field in the scalar space.

class FELiCS.Fields.fluctuationClass.fluctuationSolutions(param, mean, FEMSpaces, omega, vmixedVector, isResponseOrDirect, gainNumber=-1, gainValue=-1)#

Bases: FELiCS.Fields.fieldProperties.fieldProperties, FELiCS.Equation.dependentVariables.heatReleaseHandler.heatReleaseHandler, FELiCS.Equation.dependentVariables.equationOfStateHandler.equationOfStateHandler, FELiCS.Equation.dependentVariables.momentumHandler.momentumHandler, FELiCS.Equation.dependentVariables.energyHandler.energyHandler, FELiCS.Equation.dependentVariables.reactionHandler.reactionHandler

Stores and manages linearized fluctuation solutions.

This class contains the computed fluctuation solutions in the mixed function space.

Initialize the fluctuationSolutions object

Parameters:

  • param (FELiCSParameter) – FELiCS parameter object containing simulation configuration.

  • mean (meanFlowClass) – Mean flow object.

  • FEMSpaces (FEMSpaceHandler) – Finite element space handler.

  • omega (complex) – Complex eigenvalue representing the frequency of the solution.

  • vmixedVector (np.ndarray) – Complex-valued vector representing the mixed solution.

  • isResponseOrDirect (bool) – Flag indicating whether the solution is a Response/Direct (True) or Forcing/Adjoint (False).

  • gainNumber (int, optional) – Index of the gain value, default is -1.

  • gainValue (float, optional) – Value of the gain, default is -1.

Variables:

  • _zeroVectorField (dolfinx.Function) – Vector-valued zero field used for initialization (not stored).

  • _FEMSpaces (FEMSpaceHandler) – High-order FEM spaces for simulation.

  • _mean (meanFlowClass) – Mean flow object.

  • _transportedQuantities (list of str) – Names of the transported quantities.

  • _param (FELiCSParameter) – Simulation configuration object.

  • _meshfilename (str) – Filename of the export mesh (if applicable).

  • _linearFunctionSpaces (FEMSpaceHandler) – Low-order FEM spaces for export mesh (if applicable).

  • _exportZeroScalarField (dolfinx.Function) – Scalar zero field on export mesh.

  • _exportZeroVectorField (dolfinx.Function) – Vector zero field on export mesh.

  • _exportMesh (FELiCSMesh) – Export mesh.

  • _uValuesList (list of str) – List of velocity component names.

  • _solution (list) – Solution vector components.

  • _meanfieldDict (dict) – Dictionary containing mean field interpolated onto export space.

  • _fieldDict (dict) – Dictionary of calculated fields (both transported and dependent).

  • _zeroField (np.ndarray) – Zero-valued array for initialization.

property solutVector#

Complex-valued vector of the fluctuation solution.

Returns:

Solution vector in mixed function space.

Return type:

np.ndarray

property solutionKind#

Type of the solution based on analysis mode and configuration.

Returns:

One of ‘Response’, ‘Forcing’, ‘Direct’, ‘Adjoint’, or empty string.

Return type:

str

property omega#

Eigenvalue (frequency) of the fluctuation solution.

Returns:

Complex frequency associated with the solution.

Return type:

complex

property gainNumber#

Gain number identifier.

Returns:

Gain index or -1 if unused.

Return type:

int

property gainValue#

Gain magnitude.

Returns:

Real-valued gain.

Return type:

float

Contents