:py:mod:`FELiCS.Fields.fieldProperties` ======================================= .. py:module:: FELiCS.Fields.fieldProperties Module Contents --------------- Classes ~~~~~~~ .. autoapisummary:: FELiCS.Fields.fieldProperties.fieldProperties Attributes ~~~~~~~~~~ .. autoapisummary:: FELiCS.Fields.fieldProperties.logger .. py:data:: logger .. py:class:: 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** :ivar _fieldDict: Dictionary containing all field variables for the current object. :vartype _fieldDict: :py:class:`dict` :ivar _zeroField: Default fallback field for missing scalar quantities. :vartype _zeroField: :py:class:`object` :ivar _oneField: Default fallback field with all coefficients set to one. :vartype _oneField: :py:class:`object` :ivar _zeroVectorField: Default fallback field for missing velocity quantities. :vartype _zeroVectorField: :py:class:`object` :ivar _mean: Reference to the mean flow object, if available. :vartype _mean: :py:class:`object` :ivar _FEMSpaces: Finite element spaces, used for projections. :vartype _FEMSpaces: :py:class:`object` :ivar _coordinateSystem: Coordinate system information for tensor operations. :vartype _coordinateSystem: :py:class:`object` :ivar __hSpec: Additional species enthalpy information, if present. :vartype __hSpec: :py:class:`dict` :ivar __reaction: Reaction information, if present. :vartype __reaction: :py:class:`object` :ivar _param: Simulation parameter object, if present. :vartype _param: :py:class:`object` :ivar _mesh: Mesh object, if present. :vartype _mesh: :py:class:`object` :ivar _fluc: Fluctuation field object, if present. :vartype _fluc: :py:class:`object` :ivar _ScalarFunctionSpace: Scalar function space for field projections. :vartype _ScalarFunctionSpace: :py:class:`object` :ivar _meanflowFilename: Filename for the mean flow data, if present. :vartype _meanflowFilename: :py:class:`str` :ivar _transportedQuantities: List of transported quantity names, if present. :vartype _transportedQuantities: :py:class:`list` of :py:class:`str` :ivar alpha: Field variable for alpha (e.g., thermal diffusivity or similar). :vartype alpha: :py:class:`object` :ivar cp: Field variable for specific heat at constant pressure. :vartype cp: :py:class:`object` :ivar dQ: Field variable for heat release rate. :vartype dQ: :py:class:`object` :ivar fieldDict: Dictionary of all field variables, with special handling for mean flow classes. :vartype fieldDict: :py:class:`dict` :ivar FieldNames: List of field variable names. :vartype FieldNames: :py:class:`list` of :py:class:`str` :ivar fluc: Fluctuation field object. :vartype fluc: :py:class:`object` :ivar forcingDomain: Field variable for the domain where forcing is applied. :vartype forcingDomain: :py:class:`object` :ivar gamma: Field variable for heat capacity ratio. :vartype gamma: :py:class:`object` :ivar Pr: Field variable for Prandtl number. :vartype Pr: :py:class:`object` :ivar UnitT: Real unit number in tensor form. :vartype UnitT: :py:class:`object` :ivar h: Field variable for enthalpy. :vartype h: :py:class:`object` :ivar he: Field variable for total enthalpy. :vartype he: :py:class:`object` :ivar hSpec: Dictionary of species enthalpy fields. :vartype hSpec: :py:class:`dict` :ivar meanflowFilename: Filename for the mean flow data. :vartype meanflowFilename: :py:class:`str` :ivar molarMass: Field variable for molar mass. :vartype molarMass: :py:class:`object` :ivar nulam: Field variable for laminar viscosity. :vartype nulam: :py:class:`object` :ivar nuTot: Field variable for total viscosity (laminar + turbulent + SGS). :vartype nuTot: :py:class:`object` :ivar p: Field variable for pressure. :vartype p: :py:class:`object` :ivar RR_prefactor: Field variable for reaction rate prefactor. :vartype RR_prefactor: :py:class:`object` :ivar Q: Field variable for total heat release. :vartype Q: :py:class:`object` :ivar R_spe: Field variable for specific gas constant. :vartype R_spe: :py:class:`object` :ivar reaction: Reaction object. :vartype reaction: :py:class:`object` :ivar spg: Field variable for sponge region term. :vartype spg: :py:class:`object` :ivar rho: Field variable for density. :vartype rho: :py:class:`object` :ivar rhou: Field variable for momentum (density * velocity). :vartype rhou: :py:class:`object` :ivar T: Field variable for temperature. :vartype T: :py:class:`object` :ivar tau: Field variable for stress tensor. :vartype tau: :py:class:`object` :ivar Tb: Field variable for burnt temperature. :vartype Tb: :py:class:`object` :ivar Tu: Field variable for unburnt temperature. :vartype Tu: :py:class:`object` :ivar responseDomain: Field variable for the response domain mask. :vartype responseDomain: :py:class:`object` :ivar u: Field variable for velocity. :vartype u: :py:class:`object` :ivar u_forcing_i: Field variable for imaginary part of velocity forcing. :vartype u_forcing_i: :py:class:`object` :ivar u_forcing_r: Field variable for real part of velocity forcing. :vartype u_forcing_r: :py:class:`object` :ivar u_forcing: Field variable for complex velocity forcing. :vartype u_forcing: :py:class:`object` :ivar ut: Field variable for transverse velocity component. :vartype ut: :py:class:`object` .. admonition:: 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. .. py:property:: alpha Get the alpha field variable, with fallback for missing data. :returns: Alpha field as tensor or fallback field. :rtype: :py:class:`object` .. py:property:: c .. py:property:: cp Get the specific heat at constant pressure. :returns: Field variable for cp. :rtype: :py:class:`object` .. py:property:: dQ Get the heat release rate field variable. :returns: Field variable for heat release rate. :rtype: :py:class:`object` .. py:property:: fieldDict Get the dictionary of all field variables, with special handling for mean flow classes. :returns: Dictionary of field variables. :rtype: :py:class:`dict` .. py:property:: FieldNames Get the list of field variable names. :returns: List of field variable names. :rtype: :py:class:`list` of :py:class:`str` .. py:property:: fluc Get the fluctuation field object. :returns: Fluctuation field object. :rtype: :py:class:`object` .. py:property:: forcingDomain Get the field variable for the domain where forcing is applied. :returns: Field variable for the forcing domain. :rtype: :py:class:`object` .. py:property:: gamma Get the heat capacity ratio (gamma). :returns: Field variable for heat capacity ratio. :rtype: :py:class:`object` .. py:property:: Pr Get the Prandtl number field variable. :returns: Field variable for Prandtl number. :rtype: :py:class:`object` .. py:property:: UnitT Get the real unit number in tensor form. :returns: Tensor representing the real unit number. :rtype: :py:class:`object` .. py:property:: h Get the enthalpy field variable. :returns: Field variable for enthalpy. :rtype: :py:class:`object` .. py:property:: he Get the total enthalpy field variable. :returns: Field variable for total enthalpy. :rtype: :py:class:`object` .. py:property:: hSpec Get the dictionary of species enthalpy fields. :returns: Dictionary of species enthalpy fields. :rtype: :py:class:`dict` .. py:property:: meanflowFilename Get the filename for the mean flow data. :returns: Filename for the mean flow data. :rtype: :py:class:`str` .. py:property:: molarMass Get the molar mass field variable. :returns: Field variable for molar mass. :rtype: :py:class:`object` .. py:property:: nulam Get the laminar viscosity field variable. :returns: Field variable for laminar viscosity. :rtype: :py:class:`object` .. py:property:: nuTot Get the total viscosity field variable (laminar + turbulent + SGS). :returns: Field variable for total viscosity. :rtype: :py:class:`object` .. py:property:: p Get the pressure field variable, with fallback for missing data. :returns: Field variable for pressure. :rtype: :py:class:`object` .. py:property:: phi .. py:property:: RR_prefactor Get the reaction rate prefactor field variable. :returns: Field variable for reaction rate prefactor. :rtype: :py:class:`object` .. py:property:: Q Get the total heat release field variable. :returns: Field variable for total heat release. :rtype: :py:class:`object` .. py:property:: R_spe Get the specific gas constant field variable. :returns: Field variable for specific gas constant. :rtype: :py:class:`object` .. py:property:: reaction Get the reaction object. :returns: Reaction object. :rtype: :py:class:`object` .. py:property:: spg Get the sponge region term field variable. :returns: Field variable for sponge region term. :rtype: :py:class:`object` .. py:property:: rho Get the density field variable, with fallback for missing data. :returns: Field variable for density. :rtype: :py:class:`object` .. py:property:: rhou Get the momentum field variable (density * velocity). :returns: Field variable for momentum. :rtype: :py:class:`object` .. py:property:: T Get the temperature field variable, with fallback for missing data. :returns: Field variable for temperature. :rtype: :py:class:`object` .. py:property:: tau Get the stress tensor field variable. :returns: Field variable for stress tensor. :rtype: :py:class:`object` .. py:property:: Tb Get the burnt temperature field variable. :returns: Field variable for burnt temperature. :rtype: :py:class:`object` .. py:property:: Tu Get the unburnt temperature field variable. :returns: Field variable for unburnt temperature. :rtype: :py:class:`object` .. py:property:: Tm .. py:property:: responseDomain Get the response domain mask field variable. :returns: Field variable for response domain mask. :rtype: :py:class:`object` .. py:property:: u Get the velocity field variable, with fallback for missing data. :returns: Field variable for velocity. :rtype: :py:class:`object` .. py:property:: u_forcing_i Get the imaginary part of the velocity forcing field variable. :returns: Field variable for imaginary part of velocity forcing. :rtype: :py:class:`object` .. py:property:: u_forcing_r Get the real part of the velocity forcing field variable. :returns: Field variable for real part of velocity forcing. :rtype: :py:class:`object` .. py:property:: u_forcing Get the complex velocity forcing field variable. :returns: Field variable for complex velocity forcing. :rtype: :py:class:`object` .. py:property:: ut Deprecated variable must be deleted Get the transverse velocity component field variable. :returns: Field variable for transverse velocity component. :rtype: :py:class:`object` :type: TODO .. py:method:: isMeanFlowClass() Check if the current object is an instance of meanFlowClass. :returns: True if the object is a meanFlowClass instance, False otherwise. :rtype: :py:class:`bool` .. py:method:: isMeanFlowVertexValuesClass() Check if the current object is an instance of meanFlowVertexValues. :returns: True if the object is a meanFlowVertexValues instance, False otherwise. :rtype: :py:class:`bool` .. py:method:: D(specie) Get the diffusion coefficient for a given species. :param specie: Name of the species. :type specie: :py:class:`str` :returns: Diffusion coefficient field for the species. :rtype: :py:class:`object` .. py:method:: forcing_i(solution) Get the imaginary part of the forcing field for a given solution variable. :param solution: Name of the solution variable. :type solution: :py:class:`str` :returns: Imaginary part of the forcing field. :rtype: :py:class:`object` .. py:method:: forcing_r(solution) Get the real part of the forcing field for a given solution variable. :param solution: Name of the solution variable. :type solution: :py:class:`str` :returns: Real part of the forcing field. :rtype: :py:class:`object` .. py:method:: forcing(solution) Get the complex forcing field for a given solution variable. :param solution: Name of the solution variable. :type solution: :py:class:`str` :returns: Complex forcing field as a tensor. :rtype: :py:class:`object` .. py:method:: rhoY(species) Get the product of density and species mass fraction. :param species: Name of the species. :type species: :py:class:`str` :returns: Field variable for rho * Y(species). :rtype: :py:class:`object` .. py:method:: Y(specie) Get the mass fraction field variable for a given species. :param specie: Name of the species. :type specie: :py:class:`str` :returns: Field variable for species mass fraction. :rtype: :py:class:`object`