Single incompressible phase derived from the phase-fraction. Used as part of the multiPhaseMixture for interface-capturing multi-phase simulations.
More...
|
| phaseModel (const word &phaseName, const dictionary &phaseDict, const fvMesh &mesh) |
|
autoPtr< phaseModel > | clone () const |
| Return clone. More...
|
|
virtual | ~phaseModel () |
| Destructor. More...
|
|
const word & | name () const |
|
const word & | keyword () const |
|
tmp< volScalarField > | d () const |
|
const dimensionedScalar & | nu () const |
| Return the laminar viscosity. More...
|
|
const dimensionedScalar & | kappa () const |
|
const dimensionedScalar & | Cp () const |
|
const dimensionedScalar & | rho () const |
|
const volVectorField & | U () const |
|
volVectorField & | U () |
|
const volVectorField & | DDtU () const |
|
volVectorField & | DDtU () |
|
const surfaceScalarField & | phi () const |
|
surfaceScalarField & | phi () |
|
const surfaceScalarField & | alphaPhi () const |
|
surfaceScalarField & | alphaPhi () |
|
void | correctInflowOutflow (surfaceScalarField &alphaPhi) const |
| Ensure that the flux at inflow/outflow BCs is preserved. More...
|
|
void | correct () |
| Correct the phase properties. More...
|
|
bool | read (const dictionary &phaseDict) |
| Read base transportProperties dictionary. More...
|
|
| ClassName ("phaseModel") |
| Runtime type information. More...
|
|
| declareRunTimeSelectionTable (autoPtr, phaseModel, phaseSystem,(const phaseSystem &fluid, const word &phaseName, const label index),(fluid, phaseName, index)) |
|
| phaseModel (const phaseSystem &fluid, const word &phaseName, const label index) |
|
autoPtr< phaseModel > | clone () const |
| Return clone. More...
|
|
virtual | ~phaseModel () |
| Destructor. More...
|
|
const word & | name () const |
| Return the name of this phase. More...
|
|
const word & | keyword () const |
| Return the name of the phase for use as the keyword in PtrDictionary. More...
|
|
label | index () const |
| Return the index of the phase. More...
|
|
const phaseSystem & | fluid () const |
| Return the system to which this phase belongs. More...
|
|
const dimensionedScalar & | residualAlpha () const |
| Return the residual phase-fraction for given phase. More...
|
|
scalar | alphaMax () const |
| Return the maximum phase-fraction (e.g. packing limit) More...
|
|
tmp< volScalarField > | d () const |
| Return the Sauter-mean diameter. More...
|
|
const autoPtr< diameterModel > & | dPtr () const |
| Return const-reference to diameterModel of the phase. More...
|
|
virtual void | correct () |
| Correct the phase properties. More...
|
|
virtual void | correctKinematics () |
| Correct the kinematics. More...
|
|
virtual void | correctThermo () |
| Correct the thermodynamics. More...
|
|
virtual void | correctTurbulence () |
| Correct the turbulence. More...
|
|
virtual void | correctEnergyTransport () |
| Correct the energy transport. More...
|
|
void | correctInflowOutflow (surfaceScalarField &alphaPhi) const |
| Ensure that the flux at inflow/outflow BCs is preserved. More...
|
|
virtual bool | read () |
| Read phase properties dictionary. More...
|
|
virtual bool | compressible () const =0 |
| Return true if the phase is compressible otherwise false. More...
|
|
virtual tmp< volScalarField > | divU () const =0 |
| Return the phase dilatation rate (d(alpha)/dt + div(alpha*phi)) More...
|
|
virtual void | divU (tmp< volScalarField > divU)=0 |
| Set the phase dilatation rate (d(alpha)/dt + div(alpha*phi)) More...
|
|
virtual bool | isothermal () const =0 |
| Return whether the phase is isothermal. More...
|
|
virtual tmp< fvScalarMatrix > | heEqn ()=0 |
| Return the enthalpy equation. More...
|
|
virtual const rhoThermo & | thermo () const =0 |
| Return the thermophysical model. More...
|
|
virtual rhoThermo & | thermoRef ()=0 |
| Access the thermophysical model. More...
|
|
virtual tmp< volScalarField > | rho () const =0 |
| Return the density field. More...
|
|
virtual bool | pure () const =0 |
| Return whether the phase is pure (i.e., not multi-component) More...
|
|
virtual tmp< fvScalarMatrix > | YiEqn (volScalarField &Yi)=0 |
| Return the species fraction equation. More...
|
|
virtual const PtrList< volScalarField > & | Y () const =0 |
| Return the species mass fractions. More...
|
|
virtual const volScalarField & | Y (const word &name) const =0 |
| Return a species mass fraction by name. More...
|
|
virtual PtrList< volScalarField > & | YRef ()=0 |
| Access the species mass fractions. More...
|
|
virtual const UPtrList< volScalarField > & | YActive () const =0 |
| Return the active species mass fractions. More...
|
|
virtual UPtrList< volScalarField > & | YActiveRef ()=0 |
| Access the active species mass fractions. More...
|
|
virtual bool | stationary () const =0 |
| Return whether the phase is stationary. More...
|
|
virtual tmp< fvVectorMatrix > | UEqn ()=0 |
| Return the momentum equation. More...
|
|
virtual tmp< fvVectorMatrix > | UfEqn ()=0 |
| Return the momentum equation for the face-based algorithm. More...
|
|
virtual tmp< volVectorField > | U () const =0 |
| Return the velocity. More...
|
|
virtual volVectorField & | URef ()=0 |
| Access the velocity. More...
|
|
virtual tmp< surfaceScalarField > | phi () const =0 |
| Return the volumetric flux. More...
|
|
virtual surfaceScalarField & | phiRef ()=0 |
| Access the volumetric flux. More...
|
|
virtual tmp< surfaceScalarField > | alphaPhi () const =0 |
| Return the volumetric flux of the phase. More...
|
|
virtual surfaceScalarField & | alphaPhiRef ()=0 |
| Access the volumetric flux of the phase. More...
|
|
virtual tmp< surfaceScalarField > | alphaRhoPhi () const =0 |
| Return the mass flux of the phase. More...
|
|
virtual surfaceScalarField & | alphaRhoPhiRef ()=0 |
| Access the mass flux of the phase. More...
|
|
virtual tmp< volVectorField > | DUDt () const =0 |
| Return the substantive acceleration. More...
|
|
virtual tmp< surfaceScalarField > | DUDtf () const =0 |
| Return the substantive acceleration on the faces. More...
|
|
virtual tmp< volScalarField > | continuityError () const =0 |
| Return the continuity error. More...
|
|
virtual tmp< volScalarField > | continuityErrorFlow () const =0 |
| Return the continuity error due to the flow field. More...
|
|
virtual tmp< volScalarField > | continuityErrorSources () const =0 |
| Return the continuity error due to any sources. More...
|
|
virtual tmp< volScalarField > | K () const =0 |
| Return the phase kinetic energy. More...
|
|
virtual tmp< volScalarField > | mu () const =0 |
| Return the laminar dynamic viscosity. More...
|
|
virtual tmp< scalarField > | mu (const label patchi) const =0 |
| Return the laminar dynamic viscosity on a patch. More...
|
|
virtual tmp< volScalarField > | nu () const =0 |
| Return the laminar kinematic viscosity. More...
|
|
virtual tmp< scalarField > | nu (const label patchi) const =0 |
| Return the laminar kinematic viscosity on a patch. More...
|
|
virtual tmp< volScalarField > | alpha () const =0 |
| Thermal diffusivity for enthalpy of mixture [kg/m/s]. More...
|
|
virtual tmp< scalarField > | alpha (const label patchi) const =0 |
| Thermal diffusivity for enthalpy of mixture for patch [kg/m/s]. More...
|
|
virtual tmp< volScalarField > | kappa () const =0 |
| Thermal diffusivity for temperature of mixture [J/m/s/K]. More...
|
|
virtual tmp< scalarField > | kappa (const label patchi) const =0 |
| Thermal diffusivity for temperature of mixture. More...
|
|
virtual tmp< volScalarField > | alphahe () const =0 |
| Thermal diffusivity for energy of mixture [kg/m/s]. More...
|
|
virtual tmp< scalarField > | alphahe (const label patchi) const =0 |
| Thermal diffusivity for energy of mixture for patch [kg/m/s]. More...
|
|
virtual tmp< volScalarField > | kappaEff (const volScalarField &alphat) const =0 |
| Effective thermal turbulent diffusivity for temperature. More...
|
|
virtual tmp< scalarField > | kappaEff (const scalarField &alphat, const label patchi) const =0 |
| Effective thermal turbulent diffusivity for temperature. More...
|
|
virtual tmp< volScalarField > | alphaEff (const volScalarField &alphat) const =0 |
| Effective thermal turbulent diffusivity of mixture [kg/m/s]. More...
|
|
virtual tmp< scalarField > | alphaEff (const scalarField &alphat, const label patchi) const =0 |
| Effective thermal turbulent diffusivity of mixture. More...
|
|
virtual tmp< volScalarField > | mut () const =0 |
| Return the turbulent dynamic viscosity. More...
|
|
virtual tmp< volScalarField > | muEff () const =0 |
| Return the effective dynamic viscosity. More...
|
|
virtual tmp< volScalarField > | nut () const =0 |
| Return the turbulent kinematic viscosity. More...
|
|
virtual tmp< volScalarField > | nuEff () const =0 |
| Return the effective kinematic viscosity. More...
|
|
virtual tmp< volScalarField > | kappaEff () const =0 |
| Effective thermal turbulent diffusivity for temperature. More...
|
|
virtual tmp< scalarField > | kappaEff (const label patchi) const =0 |
| Effective thermal turbulent diffusivity for temperature. More...
|
|
virtual tmp< volScalarField > | alphaEff () const =0 |
| Effective thermal turbulent diffusivity of mixture [kg/m/s]. More...
|
|
virtual tmp< scalarField > | alphaEff (const label patchi) const =0 |
| Effective thermal turbulent diffusivity of mixture. More...
|
|
virtual tmp< volScalarField > | k () const =0 |
| Return the turbulent kinetic energy. More...
|
|
virtual tmp< volScalarField > | pPrime () const =0 |
| Return the phase-pressure'. More...
|
|
| phaseModel (const twoPhaseSystem &fluid, const dictionary &phaseProperties, const word &phaseName) |
|
virtual | ~phaseModel () |
| Destructor. More...
|
|
const word & | name () const |
| Return the name of this phase. More...
|
|
const twoPhaseSystem & | fluid () const |
| Return the twoPhaseSystem to which this phase belongs. More...
|
|
const phaseModel & | otherPhase () const |
| Return the other phase in this two-phase system. More...
|
|
const dimensionedScalar & | residualAlpha () const |
| Return the residual phase-fraction for given phase. More...
|
|
scalar | alphaMax () const |
| Optional maximum phase-fraction (e.g. packing limit) More...
|
|
tmp< volScalarField > | d () const |
| Return the Sauter-mean diameter. More...
|
|
const PhaseCompressibleTurbulenceModel< phaseModel > & | turbulence () const |
| Return the turbulence model. More...
|
|
PhaseCompressibleTurbulenceModel< phaseModel > & | turbulence () |
| Return non-const access to the turbulence model. More...
|
|
const rhoThermo & | thermo () const |
| Return the thermophysical model. More...
|
|
rhoThermo & | thermo () |
| Return non-const access to the thermophysical model. More...
|
|
tmp< volScalarField > | nu () const |
| Return the laminar viscosity. More...
|
|
tmp< scalarField > | nu (const label patchi) const |
| Return the laminar viscosity for patch. More...
|
|
tmp< volScalarField > | mu () const |
| Return the laminar dynamic viscosity. More...
|
|
tmp< scalarField > | mu (const label patchi) const |
| Return the laminar dynamic viscosity for patch. More...
|
|
tmp< scalarField > | kappa (const label patchi) const |
| Return the thermal conductivity on a patch. More...
|
|
tmp< volScalarField > | kappa () const |
| Return the thermal conductivity. More...
|
|
tmp< volScalarField > | alphahe () const |
| Thermal diffusivity for energy of mixture [kg/m/s]. More...
|
|
tmp< scalarField > | alphahe (const label patchi) const |
| Thermal diffusivity for energy of mixture for patch [kg/m/s]. More...
|
|
tmp< volScalarField > | kappaEff (const volScalarField &alphat) const |
| Return the laminar thermal conductivity. More...
|
|
tmp< scalarField > | kappaEff (const scalarField &alphat, const label patchi) const |
| Return the laminar thermal conductivity on a patch. More...
|
|
tmp< volScalarField > | alpha () const |
| Return the laminar thermal diffusivity for enthalpy. More...
|
|
tmp< scalarField > | alpha (const label patchi) const |
| Return the laminar thermal diffusivity for enthalpy on a patch. More...
|
|
tmp< volScalarField > | alphaEff (const volScalarField &alphat) const |
| Return the effective thermal diffusivity for enthalpy. More...
|
|
tmp< scalarField > | alphaEff (const scalarField &alphat, const label patchi) const |
| Return the effective thermal diffusivity for enthalpy on a patch. More...
|
|
tmp< volScalarField > | Cp () const |
| Return the specific heat capacity. More...
|
|
const volScalarField & | rho () const |
| Return the density. More...
|
|
const volVectorField & | U () const |
| Return the velocity. More...
|
|
volVectorField & | U () |
| Return non-const access to the velocity. More...
|
|
const surfaceScalarField & | phi () const |
| Return the volumetric flux. More...
|
|
surfaceScalarField & | phi () |
| Return non-const access to the volumetric flux. More...
|
|
const surfaceScalarField & | alphaPhi () const |
| Return the volumetric flux of the phase. More...
|
|
surfaceScalarField & | alphaPhi () |
| Return non-const access to the volumetric flux of the phase. More...
|
|
const surfaceScalarField & | alphaRhoPhi () const |
| Return the mass flux of the phase. More...
|
|
surfaceScalarField & | alphaRhoPhi () |
| Return non-const access to the mass flux of the phase. More...
|
|
void | correctInflowOutflow (surfaceScalarField &alphaPhi) const |
| Ensure that the flux at inflow/outflow BCs is preserved. More...
|
|
void | correct () |
| Correct the phase properties. More...
|
|
virtual bool | read (const dictionary &phaseProperties) |
| Read phaseProperties dictionary. More...
|
|
virtual bool | read () |
| Dummy Read for transportModel. More...
|
|
| phaseModel (const word &phaseName, const volScalarField &p, const volScalarField &T) |
| Construct from components. More...
|
|
autoPtr< phaseModel > | clone () const |
| Return clone. More...
|
|
const word & | name () const |
|
const word & | keyword () const |
|
const rhoThermo & | thermo () const |
| Return const-access to phase rhoThermo. More...
|
|
rhoThermo & | thermo () |
| Return access to phase rhoThermo. More...
|
|
const volScalarField & | dgdt () const |
| Return const-access to phase divergence. More...
|
|
volScalarField & | dgdt () |
| Return access to phase divergence. More...
|
|
void | correct () |
| Correct the laminar viscosity. More...
|
|
| TypeName ("GeometricField") |
| Runtime type information. More...
|
|
| GeometricField (const IOobject &io, const Mesh &mesh, const dimensionSet &ds, const word &patchFieldType=PatchField< Type >::calculatedType()) |
| Construct given IOobject, mesh, dimensions and patch type. More...
|
|
| GeometricField (const IOobject &io, const Mesh &mesh, const dimensionSet &ds, const wordList &wantedPatchTypes, const wordList &actualPatchTypes=wordList()) |
| Construct given IOobject, mesh, dimensions and patch types. More...
|
|
| GeometricField (const IOobject &io, const Mesh &mesh, const dimensioned< Type > &dt, const word &patchFieldType=PatchField< Type >::calculatedType()) |
| Construct given IOobject, mesh, dimensioned<Type> and patch type. More...
|
|
| GeometricField (const IOobject &io, const Mesh &mesh, const dimensioned< Type > &dt, const wordList &wantedPatchTypes, const wordList &actualPatchTypes=wordList()) |
| Construct given IOobject, mesh, dimensioned<Type> and patch types. More...
|
|
| GeometricField (const IOobject &io, const Internal &diField, const PtrList< PatchField< Type >> &ptfl) |
| Copy construct from internal field and a patch list to clone. More...
|
|
| GeometricField (const IOobject &io, Internal &&diField, const PtrList< PatchField< Type >> &ptfl) |
| Move construct from internal field and a patch list to clone. More...
|
|
| GeometricField (const IOobject &io, const tmp< Internal > &tfield, const PtrList< PatchField< Type >> &ptfl) |
| Move construct from internal field and a patch list to clone. More...
|
|
| GeometricField (const Internal &diField, const PtrList< PatchField< Type >> &ptfl) |
| Copy construct from internal field and a patch list to clone. More...
|
|
| GeometricField (Internal &&diField, const PtrList< PatchField< Type >> &ptfl) |
| Move construct from internal field and a patch list to clone. More...
|
|
| GeometricField (const IOobject &io, const Mesh &mesh, const dimensionSet &ds, const Field< Type > &iField, const word &patchFieldType=PatchField< Type >::calculatedType()) |
| Copy construct from internal field, with specified patch type. More...
|
|
| GeometricField (const IOobject &io, const Mesh &mesh, const dimensionSet &ds, Field< Type > &&iField, const word &patchFieldType=PatchField< Type >::calculatedType()) |
| Move construct from internal field, with specified patch type. More...
|
|
| GeometricField (const IOobject &io, const Mesh &mesh, const dimensionSet &ds, const Field< Type > &iField, const PtrList< PatchField< Type >> &ptfl) |
| Copy construct from components. More...
|
|
| GeometricField (const IOobject &io, const Mesh &mesh, const dimensionSet &ds, Field< Type > &&iField, const PtrList< PatchField< Type >> &ptfl) |
| Move construct from internal field and a patch list to clone. More...
|
|
| GeometricField (const IOobject &io, const Mesh &mesh, const dimensionSet &ds, const tmp< Field< Type >> &tiField, const PtrList< PatchField< Type >> &ptfl) |
| Copy construct from components. More...
|
|
| GeometricField (const IOobject &io, const Mesh &mesh, const bool readOldTime=true) |
| Construct and read given IOobject. More...
|
|
| GeometricField (const IOobject &io, const Mesh &mesh, const dictionary &dict) |
| Construct from dictionary. More...
|
|
| GeometricField (const GeometricField< Type, PatchField, GeoMesh > &gf) |
| Copy construct. More...
|
|
| GeometricField (const tmp< GeometricField< Type, PatchField, GeoMesh >> &tgf) |
| Construct from tmp<GeometricField> deleting argument. More...
|
|
| GeometricField (const IOobject &io, const GeometricField< Type, PatchField, GeoMesh > &gf) |
| Construct as copy resetting IO parameters. More...
|
|
| GeometricField (const IOobject &io, const tmp< GeometricField< Type, PatchField, GeoMesh >> &tgf) |
| Construct from tmp<GeometricField> resetting IO parameters. More...
|
|
| GeometricField (const word &newName, const GeometricField< Type, PatchField, GeoMesh > &gf) |
| Copy construct with a new name. More...
|
|
| GeometricField (const word &newName, const tmp< GeometricField< Type, PatchField, GeoMesh >> &tgf) |
| Construct with a new name from tmp<GeometricField> More...
|
|
| GeometricField (const IOobject &io, const GeometricField< Type, PatchField, GeoMesh > &gf, const word &patchFieldType) |
| Construct as copy resetting IO parameters and patch type. More...
|
|
| GeometricField (const IOobject &io, const GeometricField< Type, PatchField, GeoMesh > &gf, const labelList &patchIDs, const word &patchFieldType) |
| Construct as copy resetting IO parameters and boundary type for selected patchIDs. More...
|
|
| GeometricField (const IOobject &io, const GeometricField< Type, PatchField, GeoMesh > &gf, const wordList &patchFieldTypes, const wordList &actualPatchTypes=wordList()) |
| Construct as copy resetting IO parameters and boundary types. More...
|
|
| GeometricField (const IOobject &io, const tmp< GeometricField< Type, PatchField, GeoMesh >> &tgf, const wordList &patchFieldTypes, const wordList &actualPatchTypes=wordList()) |
| Construct as copy resetting IO parameters and boundary types. More...
|
|
tmp< GeometricField< Type, PatchField, GeoMesh > > | clone () const |
| Clone. More...
|
|
virtual | ~GeometricField () |
| Destructor. More...
|
|
const Internal & | internalField () const noexcept |
| Return a const-reference to the dimensioned internal field. More...
|
|
Internal & | internalFieldRef (const bool updateAccessTime=true) |
| Return a reference to the dimensioned internal field. More...
|
|
Internal & | ref (const bool updateAccessTime=true) |
| Same as internalFieldRef() More...
|
|
const Internal & | v () const |
| Return a const-reference to the dimensioned internal field of a "vol" field. More...
|
|
const Internal::FieldType & | primitiveField () const noexcept |
| Return a const-reference to the internal field values. More...
|
|
Internal::FieldType & | primitiveFieldRef (const bool updateAccessTime=true) |
| Return a reference to the internal field values. More...
|
|
const Boundary & | boundaryField () const noexcept |
| Return const-reference to the boundary field. More...
|
|
Boundary & | boundaryFieldRef (const bool updateAccessTime=true) |
| Return a reference to the boundary field. More...
|
|
label | timeIndex () const noexcept |
| Return the time index of the field. More...
|
|
label & | timeIndex () noexcept |
| Write-access to the time index of the field. More...
|
|
void | storeOldTimes () const |
| Store the old-time fields. More...
|
|
void | storeOldTime () const |
| Store the old-time field. More...
|
|
label | nOldTimes () const |
| Return the number of old time fields stored. More...
|
|
const GeometricField< Type, PatchField, GeoMesh > & | oldTime () const |
| Return old time field. More...
|
|
GeometricField< Type, PatchField, GeoMesh > & | oldTime () |
| Return non-const old time field. More...
|
|
void | storePrevIter () const |
| Store the field as the previous iteration value. More...
|
|
const GeometricField< Type, PatchField, GeoMesh > & | prevIter () const |
| Return previous iteration field. More...
|
|
void | correctBoundaryConditions () |
| Correct boundary field. More...
|
|
bool | needReference () const |
| Does the field need a reference level for solution. More...
|
|
tmp< GeometricField< cmptType, PatchField, GeoMesh > > | component (const direction) const |
| Return a component of the field. More...
|
|
bool | writeData (Ostream &) const |
| WriteData member function required by regIOobject. More...
|
|
tmp< GeometricField< Type, PatchField, GeoMesh > > | T () const |
| Return transpose (only if it is a tensor field) More...
|
|
void | relax (const scalar alpha) |
| Relax field (for steady-state solution). More...
|
|
void | relax () |
| Relax field (for steady-state solution). More...
|
|
word | select (bool final) const |
| Select the final iteration parameters if `final' is true. More...
|
|
void | writeMinMax (Ostream &os) const |
| Helper function to write the min and max to an Ostream. More...
|
|
void | negate () |
| Negate the field inplace. See notes in Field. More...
|
|
void | normalise () |
| Normalise the field inplace. See notes in Field. More...
|
|
void | replace (const direction d, const GeometricField< cmptType, PatchField, GeoMesh > &gcf) |
| Replace specified field component with content from another field. More...
|
|
void | replace (const direction d, const dimensioned< cmptType > &ds) |
| Replace specified field component with specified value. More...
|
|
void | min (const dimensioned< Type > &dt) |
| Use the minimum of the field and specified value. More...
|
|
void | max (const dimensioned< Type > &dt) |
| Use the maximum of the field and specified value. More...
|
|
void | clip (const dimensioned< MinMax< Type >> &range) |
| Clip the field to be bounded within the specified range. More...
|
|
void | clip (const dimensioned< Type > &minVal, const dimensioned< Type > &maxVal) |
| Clip the field to be bounded within the specified range. More...
|
|
void | maxMin (const dimensioned< Type > &minVal, const dimensioned< Type > &maxVal) |
| Deprecated(2019-01) identical to clip() More...
|
|
const Internal & | operator() () const |
| Return a const-reference to the dimensioned internal field. Same as internalField(). More...
|
|
void | operator= (const GeometricField< Type, PatchField, GeoMesh > &) |
|
void | operator= (const tmp< GeometricField< Type, PatchField, GeoMesh >> &) |
|
void | operator= (const dimensioned< Type > &) |
|
void | operator== (const tmp< GeometricField< Type, PatchField, GeoMesh >> &) |
|
void | operator== (const dimensioned< Type > &) |
|
void | operator+= (const GeometricField< Type, PatchField, GeoMesh > &) |
|
void | operator+= (const tmp< GeometricField< Type, PatchField, GeoMesh >> &) |
|
void | operator-= (const GeometricField< Type, PatchField, GeoMesh > &) |
|
void | operator-= (const tmp< GeometricField< Type, PatchField, GeoMesh >> &) |
|
void | operator*= (const GeometricField< scalar, PatchField, GeoMesh > &) |
|
void | operator*= (const tmp< GeometricField< scalar, PatchField, GeoMesh >> &) |
|
void | operator/= (const GeometricField< scalar, PatchField, GeoMesh > &) |
|
void | operator/= (const tmp< GeometricField< scalar, PatchField, GeoMesh >> &) |
|
void | operator+= (const dimensioned< Type > &) |
|
void | operator-= (const dimensioned< Type > &) |
|
void | operator*= (const dimensioned< scalar > &) |
|
void | operator/= (const dimensioned< scalar > &) |
|
template<> |
tmp< GeometricField< scalar, faPatchField, areaMesh > > | component (const direction) const |
|
template<> |
void | replace (const direction, const GeometricField< scalar, faPatchField, areaMesh > &gsf) |
|
template<> |
tmp< GeometricField< scalar, faPatchField, areaMesh > > | component (const direction) const |
|
template<> |
void | replace (const direction, const GeometricField< scalar, faPatchField, areaMesh > &sf) |
|
template<> |
tmp< GeometricField< scalar, fvPatchField, volMesh > > | component (const direction) const |
|
template<> |
void | replace (const direction, const GeometricField< scalar, fvPatchField, volMesh > &gsf) |
|
template<> |
tmp< GeometricField< scalar, fvPatchField, volMesh > > | component (const direction) const |
|
template<> |
void | replace (const direction, const GeometricField< scalar, fvPatchField, volMesh > &sf) |
|
template<class AnyType > |
Foam::tmp< Foam::GeometricField< Type, PatchField, GeoMesh > > | New (const GeometricField< AnyType, PatchField, GeoMesh > &fld, const word &name, const dimensionSet &dims, const word &patchFieldType) |
|
template<class AnyType > |
Foam::tmp< Foam::GeometricField< Type, PatchField, GeoMesh > > | New (const GeometricField< AnyType, PatchField, GeoMesh > &fld, const word &name, const dimensioned< Type > &dt, const word &patchFieldType) |
|
| TypeName ("DimensionedField") |
| Runtime type information. More...
|
|
| DimensionedField (const IOobject &io, const Mesh &mesh, const dimensionSet &dims, const Field< Type > &field) |
| Construct from components, copy initial field content. More...
|
|
| DimensionedField (const IOobject &io, const Mesh &mesh, const dimensionSet &dims, Field< Type > &&field) |
| Construct from components, transferring initial field content. More...
|
|
| DimensionedField (const IOobject &io, const Mesh &mesh, const dimensionSet &dims, List< Type > &&field) |
| Construct from components, transferring initial field content. More...
|
|
| DimensionedField (const IOobject &io, const Mesh &mesh, const dimensionSet &dims, const tmp< Field< Type >> &tfield) |
| Construct from components, copy or transfer tmp content. More...
|
|
| DimensionedField (const IOobject &io, const Mesh &mesh, const dimensionSet &dims, const bool checkIOFlags=true) |
| Construct from components, setting the initial size and assigning the dimensions, but not initialising any field values. More...
|
|
| DimensionedField (const IOobject &io, const Mesh &mesh, const dimensioned< Type > &dt, const bool checkIOFlags=true) |
| Construct from components, setting the initial size and assigning both dimensions and values. More...
|
|
| DimensionedField (const IOobject &io, const Mesh &mesh, const word &fieldDictEntry="value") |
| Construct from Istream. More...
|
|
| DimensionedField (const IOobject &io, const Mesh &mesh, const dictionary &fieldDict, const word &fieldDictEntry="value") |
| Construct from dictionary. More...
|
|
| DimensionedField (const DimensionedField< Type, GeoMesh > &df) |
| Copy construct. More...
|
|
| DimensionedField (DimensionedField< Type, GeoMesh > &&df) |
| Move construct. More...
|
|
| DimensionedField (DimensionedField< Type, GeoMesh > &df, bool reuse) |
| Copy construct or reuse (move) as specified. More...
|
|
| DimensionedField (const tmp< DimensionedField< Type, GeoMesh >> &tdf) |
| Construct from tmp<DimensionedField> deleting argument. More...
|
|
| DimensionedField (const IOobject &io, const DimensionedField< Type, GeoMesh > &df) |
| Copy construct, resetting IO parameters. More...
|
|
| DimensionedField (const IOobject &io, DimensionedField< Type, GeoMesh > &&df) |
| Move construct, resetting IO parameters. More...
|
|
| DimensionedField (const IOobject &io, DimensionedField< Type, GeoMesh > &df, bool reuse) |
| Copy or move construct, resetting IO parameters. More...
|
|
| DimensionedField (const IOobject &io, const tmp< DimensionedField< Type, GeoMesh >> &tdf) |
| Construct from tmp<DimensionedField> deleting argument, resetting IO parameters. More...
|
|
| DimensionedField (const word &newName, const DimensionedField< Type, GeoMesh > &df) |
| Copy construct with a new name. More...
|
|
| DimensionedField (const word &newName, DimensionedField< Type, GeoMesh > &&df) |
| Move construct with a new name. More...
|
|
| DimensionedField (const word &newName, DimensionedField< Type, GeoMesh > &df, bool reuse) |
| Copy or move construct, resetting name. More...
|
|
| DimensionedField (const word &newName, const tmp< DimensionedField< Type, GeoMesh >> &tdf) |
| Construct with a new name from tmp<DimensionedField> More...
|
|
tmp< DimensionedField< Type, GeoMesh > > | clone () const |
| Clone. More...
|
|
virtual | ~DimensionedField ()=default |
| Destructor. More...
|
|
void | readField (const dictionary &fieldDict, const word &fieldDictEntry="value") |
|
const Mesh & | mesh () const noexcept |
| Return mesh. More...
|
|
const dimensionSet & | dimensions () const noexcept |
| Return dimensions. More...
|
|
dimensionSet & | dimensions () noexcept |
| Return non-const access to dimensions. More...
|
|
orientedType | oriented () const noexcept |
| Return oriented type. More...
|
|
orientedType & | oriented () noexcept |
| Return non-const access to the oriented type. More...
|
|
bool | is_oriented () const noexcept |
| True if field is ORIENTED. More...
|
|
void | setOriented (bool on=true) noexcept |
| Set the oriented flag: on/off. More...
|
|
const Field< Type > & | field () const noexcept |
| Return const-reference to the field values. More...
|
|
Field< Type > & | field () noexcept |
| Return reference to the field values. More...
|
|
tmp< DimensionedField< cmptType, GeoMesh > > | component (const direction d) const |
| Return a component field of the field. More...
|
|
void | replace (const direction d, const DimensionedField< cmptType, GeoMesh > &df) |
| Replace a component field of the field. More...
|
|
void | replace (const direction d, const tmp< DimensionedField< cmptType, GeoMesh >> &tdf) |
| Replace a component field of the field. More...
|
|
tmp< DimensionedField< Type, GeoMesh > > | T () const |
| Return the field transpose (only defined for second rank tensors) More...
|
|
dimensioned< Type > | average () const |
| Calculate and return arithmetic average. More...
|
|
dimensioned< Type > | weightedAverage (const DimensionedField< scalar, GeoMesh > &weightField) const |
| Calculate and return weighted average. More...
|
|
dimensioned< Type > | weightedAverage (const tmp< DimensionedField< scalar, GeoMesh >> &tweightField) const |
| Calculate and return weighted average. More...
|
|
bool | writeData (Ostream &os, const word &fieldDictEntry) const |
|
void | operator= (const DimensionedField< Type, GeoMesh > &df) |
|
void | operator= (const tmp< DimensionedField< Type, GeoMesh >> &tdf) |
|
void | operator= (const dimensioned< Type > &dt) |
| Assign dimensions and value. More...
|
|
void | operator+= (const DimensionedField< Type, GeoMesh > &df) |
|
void | operator+= (const tmp< DimensionedField< Type, GeoMesh >> &tdf) |
|
void | operator-= (const DimensionedField< Type, GeoMesh > &df) |
|
void | operator-= (const tmp< DimensionedField< Type, GeoMesh >> &tdf) |
|
void | operator*= (const DimensionedField< scalar, GeoMesh > &df) |
|
void | operator*= (const tmp< DimensionedField< scalar, GeoMesh >> &tdf) |
|
void | operator/= (const DimensionedField< scalar, GeoMesh > &df) |
|
void | operator/= (const tmp< DimensionedField< scalar, GeoMesh >> &tdf) |
|
void | operator+= (const dimensioned< Type > &dt) |
|
void | operator-= (const dimensioned< Type > &dt) |
|
void | operator*= (const dimensioned< scalar > &dt) |
|
void | operator/= (const dimensioned< scalar > &dt) |
|
template<> |
const word | typeName ("volScalarField::Internal") |
|
template<> |
const word | typeName ("volVectorField::Internal") |
|
template<> |
const word | typeName ("volSphericalTensorField::Internal") |
|
template<> |
const word | typeName ("volSymmTensorField::Internal") |
|
template<> |
const word | typeName ("volTensorField::Internal") |
|
template<class AnyType > |
Foam::tmp< Foam::DimensionedField< Type, GeoMesh > > | New (const DimensionedField< AnyType, GeoMesh > &fld, const word &name, const dimensionSet &dims) |
|
template<class AnyType > |
Foam::tmp< Foam::DimensionedField< Type, GeoMesh > > | New (const DimensionedField< AnyType, GeoMesh > &fld, const word &name, const dimensioned< Type > &dt) |
|
| TypeName ("regIOobject") |
| Runtime type information. More...
|
|
| regIOobject (const IOobject &io, const bool isTimeObject=false) |
| Construct from IOobject. The optional flag adds special handling if the object is the top-level regIOobject (eg, Time). More...
|
|
| regIOobject (const regIOobject &rio) |
| Copy construct. More...
|
|
| regIOobject (const regIOobject &rio, bool registerCopy) |
| Copy construct, transferring registry registration to the copy if registerCopy is true. More...
|
|
| regIOobject (const word &newName, const regIOobject &, bool registerCopy) |
| Copy construct with new name, transferring registry registration to the copy f registerCopy is true. More...
|
|
| regIOobject (const IOobject &io, const regIOobject &rio) |
| Copy construct with new IO parameters. More...
|
|
virtual | ~regIOobject () |
| Destructor. More...
|
|
bool | checkIn () |
| Add object to registry, if not already registered. More...
|
|
bool | checkOut () |
| Remove all file watches and remove object from registry. More...
|
|
virtual void | addWatch () |
| Add file watch on object (if registered and READ_IF_MODIFIED) More...
|
|
bool | registered () const noexcept |
| Query the registered state (ie, has been checked in). This is not necessarily the same as registerObject(), which is just a stated preference. More...
|
|
bool | ownedByRegistry () const noexcept |
| Is this object owned by the registry? More...
|
|
bool | store () |
| Register object with its registry and transfer ownership to the registry. More...
|
|
void | release (const bool unregister=false) noexcept |
| Set object as not ownedByRegistry. More...
|
|
label | eventNo () const noexcept |
| Event number at last update. More...
|
|
label & | eventNo () noexcept |
| Event number at last update. More...
|
|
bool | upToDate (const regIOobject &) const |
| Return true if up-to-date with respect to given object. More...
|
|
bool | upToDate (const regIOobject &, const regIOobject &) const |
| Return true if up-to-date with respect to given objects. More...
|
|
bool | upToDate (const regIOobject &, const regIOobject &, const regIOobject &) const |
| Return true if up-to-date with respect to given objects. More...
|
|
bool | upToDate (const regIOobject &, const regIOobject &, const regIOobject &, const regIOobject &) const |
| Return true if up-to-date with respect to given objects. More...
|
|
void | setUpToDate () |
| Set as up-to-date. More...
|
|
virtual void | rename (const word &newName) |
| Rename. More...
|
|
const dictionary * | findMetaData () const noexcept |
| Return pointer to meta-data or nullptr. More...
|
|
dictionary & | getMetaData () noexcept |
| Get or create meta-data. More...
|
|
void | removeMetaData () |
| Remove meta-data. More...
|
|
virtual void | updateMetaData () |
| Update internal meta-data (eg, prior to writing) More...
|
|
virtual fileName | filePath () const |
| Return complete path + object name if the file exists. More...
|
|
bool | headerOk () |
| Read and check header info. Does not check the headerClassName. More...
|
|
Istream & | readStream (const word &, const bool valid=true) |
| Return Istream and check object type against that given. More...
|
|
void | close () |
| Close Istream. More...
|
|
virtual bool | readData (Istream &) |
| Virtual readData function. More...
|
|
virtual label | addWatch (const fileName &) |
| Add file watch for fileName on object if not yet watched. More...
|
|
const labelList & | watchIndices () const noexcept |
| Read access to file-monitoring handles. More...
|
|
labelList & | watchIndices () noexcept |
| Write access to file-monitoring handles. More...
|
|
virtual bool | modified () const |
| Return true if the object's file (or files for objectRegistry) have been modified. (modified state is cached by Time) More...
|
|
virtual bool | readIfModified () |
| Read object if modified (as set by call to modified) More...
|
|
virtual bool | writeObject (IOstreamOption streamOpt, const bool valid) const |
| Write using stream options. More...
|
|
virtual bool | write (const bool valid=true) const |
| Write using setting from DB. More...
|
|
virtual bool | global () const |
| Is object global. More...
|
|
void | operator= (const IOobject &io) |
| Copy assignment. More...
|
|
virtual bool | writeObject (IOstreamOption::streamFormat fmt, IOstreamOption::versionNumber ver, IOstreamOption::compressionType cmp, const bool valid) const |
| Write using given format, version and compression. More...
|
|
| TypeName ("IOobject") |
| Declare type-name, virtual type (with debug switch) More...
|
|
| IOobject (const IOobject &)=default |
| Copy construct. More...
|
|
virtual | ~IOobject ()=default |
| Destructor. More...
|
|
| IOobject (const word &name, const fileName &instance, const objectRegistry ®istry, IOobjectOption ioOpt=IOobjectOption()) |
| Construct from name, instance, registry, io options. More...
|
|
| IOobject (const word &name, const fileName &instance, const fileName &local, const objectRegistry ®istry, IOobjectOption ioOpt=IOobjectOption()) |
| Construct from name, instance, local, registry, io options. More...
|
|
| IOobject (const fileName &path, const objectRegistry ®istry, IOobjectOption ioOpt=IOobjectOption()) |
| Construct from path, registry, io options. More...
|
|
| IOobject (const word &name, const fileName &instance, const objectRegistry ®istry, IOobjectOption::readOption rOpt, IOobjectOption::writeOption wOpt=IOobjectOption::NO_WRITE, bool registerObject=true, bool globalObject=false) |
| Construct from name, instance, registry, io options. More...
|
|
| IOobject (const word &name, const fileName &instance, const fileName &local, const objectRegistry ®istry, IOobjectOption::readOption rOpt, IOobjectOption::writeOption wOpt=IOobjectOption::NO_WRITE, bool registerObject=true, bool globalObject=false) |
| Construct from name, instance, local, registry, io options. More...
|
|
| IOobject (const fileName &path, const objectRegistry ®istry, IOobjectOption::readOption rOpt, IOobjectOption::writeOption wOpt=IOobjectOption::NO_WRITE, bool registerObject=true, bool globalObject=false) |
| Construct from path, registry, io options. More...
|
|
| IOobject (const IOobject &io, const objectRegistry ®istry) |
| Copy construct, resetting registry. More...
|
|
| IOobject (const IOobject &io, const word &name) |
| Copy construct, resetting name. More...
|
|
| IOobject (const IOobject &io, const word &name, const fileName &local) |
| Copy construct, resetting name and local component. More...
|
|
| IOobject (const IOobject &io, IOobjectOption::readOption rOpt, IOobjectOption::writeOption wOpt) |
| Copy construct, resetting read/write options. More...
|
|
autoPtr< IOobject > | clone () const |
| Clone. More...
|
|
autoPtr< IOobject > | clone (const objectRegistry ®istry) const |
| Clone resetting registry. More...
|
|
const objectRegistry & | db () const noexcept |
| Return the local objectRegistry. More...
|
|
const Time & | time () const |
| Return Time associated with the objectRegistry. More...
|
|
const word & | name () const noexcept |
| Return the object name. More...
|
|
const word & | headerClassName () const noexcept |
| Return name of the class name read from header. More...
|
|
word & | headerClassName () noexcept |
| Return non-constant access to the class name read from header. More...
|
|
const string & | note () const noexcept |
| Return the optional note. More...
|
|
string & | note () noexcept |
| Modifiable access to the optional note. More...
|
|
unsigned | labelByteSize () const noexcept |
| The sizeof (label) in bytes, possibly read from the header. More...
|
|
unsigned | scalarByteSize () const noexcept |
| The sizeof (scalar) in bytes, possibly read from the header. More...
|
|
bool | hasHeaderClass () const noexcept |
| True if headerClassName() is non-empty (after reading) More...
|
|
template<class Type > |
bool | isHeaderClass () const |
| Check if headerClassName() equals Type::typeName. More...
|
|
template<class Type > |
bool | isHeaderClassName () const |
| Same as isHeaderClass() More...
|
|
word | group () const |
| Return group (extension part of name) More...
|
|
word | member () const |
| Return member (name without the extension) More...
|
|
const fileName & | rootPath () const |
| Return the Time::rootPath() More...
|
|
const fileName & | caseName () const |
| Return the Time::caseName() More...
|
|
const fileName & | instance () const noexcept |
| Read access to instance path component. More...
|
|
fileName & | instance () noexcept |
| Write access to instance path component. More...
|
|
const fileName & | local () const noexcept |
| Read access to local path component. More...
|
|
fileName | path () const |
| The complete path. More...
|
|
fileName | path (const word &instance, const fileName &local=fileName::null) const |
| The complete path with alternative instance and local. More...
|
|
fileName | objectPath () const |
| The complete path + object name. More...
|
|
fileName | objectRelPath () const |
| The object path relative to the root. More...
|
|
fileName | localFilePath (const word &typeName, const bool search=true) const |
| Redirect to fileHandler filePath, searching locally. More...
|
|
fileName | globalFilePath (const word &typeName, const bool search=true) const |
| Redirect to fileHandler filePath, searching up if in parallel. More...
|
|
IOstreamOption | parseHeader (const dictionary &headerDict) |
| Parse 'FoamFile' header contents and set the IOobject characteristics and return the stream characteristics. More...
|
|
bool | readHeader (Istream &is) |
| Read header ('FoamFile' dictionary) and set the IOobject and stream characteristics. More...
|
|
bool | readHeader (dictionary &headerDict, Istream &is) |
| Read header (the 'FoamFile' dictionary) and set the IOobject and stream characteristics. More...
|
|
template<class Type > |
bool | typeHeaderOk (const bool checkType=true, const bool search=true, const bool verbose=true) |
| Read header (uses typeFilePath to find file) and check its info. More...
|
|
template<class Type > |
void | warnNoRereading () const |
| Helper: warn that type does not support re-reading. More...
|
|
bool | writeHeader (Ostream &os) const |
| Write header with current type() More...
|
|
bool | writeHeader (Ostream &os, const word &objectType) const |
| Write header with override of type. More...
|
|
void | writeHeader (dictionary &dict, IOstreamOption streamOpt) const |
| Write header into a dictionary with current type() and given output format. More...
|
|
void | writeHeader (dictionary &dict, const word &objectType, IOstreamOption streamOpt) const |
| Write header into a dictionary with override of type and given output format. More...
|
|
bool | good () const noexcept |
| Did last readHeader() succeed? More...
|
|
bool | bad () const noexcept |
| Did last readHeader() fail? More...
|
|
InfoProxy< IOobject > | info () const |
| Return info proxy, for printing information to a stream. More...
|
|
void | operator= (const IOobject &io) |
| Copy assignment, copies all values (except the registry) More...
|
|
template<> |
bool | isHeaderClass () const |
| Specialization for void always returns true (no headerClassName check). More...
|
|
template<class StringType > |
Foam::word | groupName (StringType base, const word &group) |
|
constexpr | IOobjectOption (readOption rOpt=readOption::NO_READ, writeOption wOpt=writeOption::NO_WRITE, registerOption registerObject=registerOption::REGISTER, bool globalObject=false) noexcept |
| Default construct (NO_READ, NO_WRITE, register, non-global) or construct with specified options. More...
|
|
constexpr | IOobjectOption (readOption rOpt, registerOption registerObject=registerOption::REGISTER, bool globalObject=false) noexcept |
| Construct NO_WRITE with specified read/register options. More...
|
|
constexpr | IOobjectOption (writeOption wOpt, registerOption registerObject=registerOption::REGISTER, bool globalObject=false) noexcept |
| Construct NO_READ with specified write/register options. More...
|
|
constexpr | IOobjectOption (registerOption registerObject, bool globalObject=false) noexcept |
| Construct (NO_READ, NO_WRITE) with specified register option. More...
|
|
constexpr | IOobjectOption (readOption rOpt, writeOption wOpt, bool registerObject, bool globalObject=false) noexcept |
| Construct from components with specified register option as bool. More...
|
|
constexpr | IOobjectOption (bool registerObject, bool globalObject=false) noexcept |
| Construct (NO_READ, NO_WRITE) with specified register option as bool. More...
|
|
readOption | readOpt () const noexcept |
| Get the read option. More...
|
|
readOption | readOpt (readOption opt) noexcept |
| Set the read option. More...
|
|
writeOption | writeOpt () const noexcept |
| Get the write option. More...
|
|
writeOption | writeOpt (writeOption opt) noexcept |
| Set the write option. More...
|
|
bool | registerObject () const noexcept |
| Should objects created with this IOobject be registered? More...
|
|
bool | registerObject (bool on) noexcept |
| Change registration preference. More...
|
|
bool | globalObject () const noexcept |
| True if object is treated the same for all processors. More...
|
|
bool | globalObject (bool on) noexcept |
| Change global-object status. More...
|
|
bool | isReadRequired () const noexcept |
| True if (MUST_READ | MUST_READ_IF_MODIFIED) bits are set. More...
|
|
bool | isReadOptional () const noexcept |
| True if (READ_IF_PRESENT) bits are set. More...
|
|
readOption & | readOpt () noexcept |
| Access to the read option. More...
|
|
writeOption & | writeOpt () noexcept |
| Access to the write option. More...
|
|
bool & | registerObject () noexcept |
| Access to the register object option. More...
|
|
bool & | globalObject () noexcept |
| Access to the global object option. More...
|
|
constexpr | Field () noexcept |
| Default construct. More...
|
|
| Field (const label len) |
| Construct given size. More...
|
|
| Field (const label len, const Type &val) |
| Construct given size and initial value. More...
|
|
| Field (const label len, const Foam::zero) |
| Construct given size and initial values of zero. More...
|
|
| Field (const Foam::one, const Type &val) |
| Construct with length=1, copying the value as the only content. More...
|
|
| Field (const Foam::one, Type &&val) |
| Construct with length=1, moving the value as the only content. More...
|
|
| Field (const Foam::one, const Foam::zero) |
| Construct with length=1, initializing content to zero. More...
|
|
| Field (const Field< Type > &fld) |
| Copy construct. More...
|
|
| Field (const UList< Type > &list) |
| Copy construct from UList<Type> More...
|
|
template<class Addr > |
| Field (const IndirectListBase< Type, Addr > &list) |
| Copy construct from IndirectList. More...
|
|
| Field (Field< Type > &&fld) |
| Move construct from Field. More...
|
|
| Field (List< Type > &&list) |
| Move construct from List. More...
|
|
template<int SizeMin> |
| Field (DynamicList< Type, SizeMin > &&list) |
| Move construct from DynamicList. More...
|
|
| Field (const UList< Type > &mapF, const labelUList &mapAddressing) |
| Construct by 1 to 1 mapping from the given field. More...
|
|
| Field (const tmp< Field< Type >> &tmapF, const labelUList &mapAddressing) |
| Construct by 1 to 1 mapping from the given tmp field. More...
|
|
| Field (const UList< Type > &mapF, const labelListList &mapAddressing, const scalarListList &weights) |
| Construct by interpolative mapping from the given field. More...
|
|
| Field (const tmp< Field< Type >> &tmapF, const labelListList &mapAddressing, const scalarListList &weights) |
| Construct by interpolative mapping from the given tmp field. More...
|
|
| Field (const UList< Type > &mapF, const FieldMapper &map, const bool applyFlip=true) |
| Construct by mapping from the given field. More...
|
|
| Field (const UList< Type > &mapF, const FieldMapper &map, const Type &defaultValue, const bool applyFlip=true) |
| Construct by mapping from the given field. More...
|
|
| Field (const UList< Type > &mapF, const FieldMapper &map, const UList< Type > &defaultValues, const bool applyFlip=true) |
| Construct by mapping from the given field. More...
|
|
| Field (const tmp< Field< Type >> &tmapF, const FieldMapper &map, const bool applyFlip=true) |
| Construct by mapping from the given tmp field. More...
|
|
| Field (const tmp< Field< Type >> &tmapF, const FieldMapper &map, const Type &defaultValue, const bool applyFlip=true) |
| Construct by mapping from the given tmp field. Uses supplied uniform value for unmapped items. More...
|
|
| Field (const tmp< Field< Type >> &tmapF, const FieldMapper &map, const UList< Type > &defaultValues, const bool applyFlip=true) |
| Construct by mapping from the given tmp field. Uses supplied values for unmapped items. More...
|
|
| Field (Field< Type > &fld, bool reuse) |
| Copy construct or re-use as specified. More...
|
|
| Field (const tmp< Field< Type >> &tfld) |
| Copy or move construct from tmp. More...
|
|
| Field (Istream &is) |
| Construct from Istream. More...
|
|
| Field (const entry &e, const label len) |
| Construct from a dictionary (primitive) entry. More...
|
|
| Field (const word &keyword, const dictionary &dict, const label len, enum keyType::option matchOpt=keyType::REGEX) |
| Construct from lookup of a dictionary (primitive) entry. More...
|
|
tmp< Field< Type > > | clone () const |
| Clone. More...
|
|
void | assign (const entry &e, const label len) |
| Assign from a dictionary (primitive) entry. More...
|
|
void | assign (const word &keyword, const dictionary &dict, const label len, enum keyType::option matchOpt=keyType::REGEX) |
| Assign from lookup of a dictionary (primitive) entry. More...
|
|
void | map (const UList< Type > &mapF, const labelUList &mapAddressing) |
| 1 to 1 map from the given field More...
|
|
void | map (const tmp< Field< Type >> &tmapF, const labelUList &mapAddressing) |
| 1 to 1 map from the given tmp field More...
|
|
void | map (const UList< Type > &mapF, const labelListList &mapAddressing, const scalarListList &weights) |
| Interpolative map from the given field. More...
|
|
void | map (const tmp< Field< Type >> &tmapF, const labelListList &mapAddressing, const scalarListList &weights) |
| Interpolative map from the given tmp field. More...
|
|
void | map (const UList< Type > &mapF, const FieldMapper &map, const bool applyFlip=true) |
| Map from the given field. More...
|
|
void | map (const tmp< Field< Type >> &tmapF, const FieldMapper &map, const bool applyFlip=true) |
| Map from the given tmp field. More...
|
|
void | autoMap (const FieldMapper &map, const bool applyFlip=true) |
| Map from self. More...
|
|
void | rmap (const UList< Type > &mapF, const labelUList &mapAddressing) |
| 1 to 1 reverse-map from the given field More...
|
|
void | rmap (const tmp< Field< Type >> &tmapF, const labelUList &mapAddressing) |
| 1 to 1 reverse-map from the given tmp field More...
|
|
void | rmap (const UList< Type > &mapF, const labelUList &mapAddressing, const UList< scalar > &weights) |
| Interpolative reverse map from the given field. More...
|
|
void | rmap (const tmp< Field< Type >> &tmapF, const labelUList &mapAddressing, const UList< scalar > &weights) |
| Interpolative reverse map from the given tmp field. More...
|
|
void | negate () |
| Inplace negate this field (negative). More...
|
|
void | normalise () |
| Inplace normalise this field. Generally a no-op except for vector fields. More...
|
|
tmp< Field< cmptType > > | component (const direction) const |
| Return a component field of the field. More...
|
|
void | replace (const direction, const UList< cmptType > &) |
| Replace a component field of the field. More...
|
|
void | replace (const direction, const tmp< Field< cmptType >> &) |
| Replace a component field of the field. More...
|
|
void | replace (const direction, const cmptType &) |
| Replace a component field of the field. More...
|
|
template<class VSForm > |
VSForm | block (const label start) const |
|
tmp< Field< Type > > | T () const |
| Return the field transpose (only defined for second rank tensors) More...
|
|
void | writeEntry (const word &keyword, Ostream &os) const |
| Write the field as a dictionary entry. More...
|
|
SubField< Type > | slice (const label pos, label len=-1) |
| Return SubField slice (non-const access) - no range checking. More...
|
|
const SubField< Type > | slice (const label pos, label len=-1) const |
| Return SubField slice (const access) - no range checking. More...
|
|
SubField< Type > | slice (const labelRange &range) |
| Return SubField slice (non-const access) - with range checking. More...
|
|
const SubField< Type > | slice (const labelRange &range) const |
| Return SubField slice (const access) - with range checking. More...
|
|
void | operator= (const Field< Type > &) |
| Copy assignment. More...
|
|
void | operator= (const tmp< Field< Type >> &) |
|
void | operator= (const UList< Type > &rhs) |
|
void | operator= (const SubField< Type > &rhs) |
|
template<class Addr > |
void | operator= (const IndirectListBase< Type, Addr > &rhs) |
| Copy assign from IndirectList. More...
|
|
void | operator= (Field< Type > &&rhs) |
| Move assignment. More...
|
|
void | operator= (List< Type > &&rhs) |
|
template<int SizeMin> |
void | operator= (DynamicList< Type, SizeMin > &&rhs) |
|
void | operator= (const Type &val) |
| Value assignment. More...
|
|
void | operator= (const Foam::zero) |
|
template<class Form , class Cmpt , direction nCmpt> |
void | operator= (const VectorSpace< Form, Cmpt, nCmpt > &) |
|
void | operator+= (const UList< Type > &) |
|
void | operator+= (const tmp< Field< Type >> &) |
|
void | operator-= (const UList< Type > &) |
|
void | operator-= (const tmp< Field< Type >> &) |
|
void | operator*= (const UList< scalar > &) |
|
void | operator*= (const tmp< Field< scalar >> &) |
|
void | operator/= (const UList< scalar > &) |
|
void | operator/= (const tmp< Field< scalar >> &) |
|
void | operator+= (const Type &) |
|
void | operator-= (const Type &) |
|
void | operator*= (const scalar &) |
|
void | operator/= (const scalar &) |
|
template<class Type> |
void | operator= (const tmp< Field > &rhs) |
|
template<> |
void | normalise () |
|
template<> |
void | normalise () |
|
template<> |
void | normalise () |
| Inplace normalise (float) vector field. More...
|
|
template<> |
void | normalise () |
| Inplace normalise (double) vector field. More...
|
|
constexpr | FieldBase () noexcept |
| Default construct. More...
|
|
constexpr | refCount () noexcept |
| Default construct, initializing count to 0. More...
|
|
int | count () const noexcept |
| Return the current reference count. More...
|
|
bool | unique () const noexcept |
| Return true if the reference count is zero. More...
|
|
void | operator++ () noexcept |
| Increment the reference count. More...
|
|
void | operator++ (int) noexcept |
| Increment the reference count. More...
|
|
void | operator-- () noexcept |
| Decrement the reference count. More...
|
|
void | operator-- (int) noexcept |
| Decrement the reference count. More...
|
|
constexpr | List () noexcept |
| Default construct. More...
|
|
| List (const label len) |
| Construct with given size. More...
|
|
| List (const label len, const Type &val) |
| Construct with given size and value for all elements. More...
|
|
| List (const label len, const Foam::zero) |
| Construct with given size initializing all elements to zero. More...
|
|
| List (const Foam::one, const Type &val) |
| Construct with length=1, copying the value as the only content. More...
|
|
| List (const Foam::one, Type &&val) |
| Construct with length=1, moving the value as the only content. More...
|
|
| List (const Foam::one, const Foam::zero) |
| Construct with length=1, initializing content to zero. More...
|
|
| List (const List< Type > &a) |
| Copy construct from list. More...
|
|
| List (const UList< Type > &a) |
| Copy construct contents from list. More...
|
|
| List (List< Type > &a, bool reuse) |
| Construct as copy or re-use as specified. More...
|
|
| List (const UList< Type > &list, const labelUList &indices) |
| Copy construct subset of list. More...
|
|
| List (const UList< Type > &list, const FixedList< label, N > &indices) |
| Copy construct subset of list. More...
|
|
| List (const FixedList< Type, N > &list) |
| Construct as copy of FixedList<T, N> More...
|
|
| List (const PtrList< Type > &list) |
| Construct as copy of PtrList<T> More...
|
|
| List (const SLList< Type > &list) |
| Construct as copy of SLList<T> More...
|
|
| List (const IndirectListBase< Type, Addr > &list) |
| Construct as copy of IndirectList contents. More...
|
|
| List (std::initializer_list< Type > list) |
| Construct from an initializer list. More...
|
|
| List (List< Type > &&list) |
| Move construct from List. More...
|
|
| List (DynamicList< Type, SizeMin > &&list) |
| Move construct from DynamicList. More...
|
|
| List (SLList< Type > &&list) |
| Move construct from SLList. More...
|
|
| List (Istream &is) |
| Construct from Istream. More...
|
|
autoPtr< List< Type > > | clone () const |
| Clone. More...
|
|
| ~List () |
| Destructor. More...
|
|
void | clear () |
| Clear the list, i.e. set size to zero. More...
|
|
void | resize (const label len) |
| Adjust allocated size of list. More...
|
|
void | resize (const label len, const Type &val) |
| Adjust allocated size of list and set val for new elements. More...
|
|
void | resize (const label newLen) |
|
void | resize_nocopy (const label len) |
| Adjust allocated size of list without necessarily. More...
|
|
void | setSize (const label n) |
| Alias for resize() More...
|
|
void | setSize (const label n, const Type &val) |
| Alias for resize() More...
|
|
void | transfer (List< Type > &list) |
| Transfer the contents of the argument List into this list and annul the argument list. More...
|
|
void | transfer (DynamicList< Type, SizeMin > &list) |
| Transfer the contents of the argument List into this list and annul the argument list. More...
|
|
Type & | newElmt (const label i) |
| Return subscript-checked element of UList and resizing the list if required. More...
|
|
void | push_back (const Type &val) |
| Append an element at the end of the list. More...
|
|
void | push_back (Type &&val) |
| Move append an element at the end of the list. More...
|
|
void | push_back (const UList< Type > &list) |
| Append a List to the end of this list. More...
|
|
void | push_back (const IndirectListBase< Type, Addr > &list) |
| Append IndirectList contents at the end of this list. More...
|
|
label | push_uniq (const Type &val) |
| Append an element if not already in the list. More...
|
|
void | pop_back (label n=1) |
| Reduce size by 1 or more elements. Can be called on an empty list. More...
|
|
void | operator= (const UList< Type > &a) |
| Assignment to UList operator. Takes linear time. More...
|
|
void | operator= (const List< Type > &list) |
| Assignment operator. Takes linear time. More...
|
|
void | operator= (const SLList< Type > &list) |
| Assignment to SLList operator. Takes linear time. More...
|
|
void | operator= (const IndirectListBase< Type, Addr > &list) |
| Assignment from IndirectList. Takes linear time. More...
|
|
void | operator= (const FixedList< Type, N > &list) |
| Copy assignment from FixedList. More...
|
|
void | operator= (std::initializer_list< Type > list) |
| Assignment to an initializer list. More...
|
|
void | operator= (const Type &val) |
| Assignment of all entries to the given value. More...
|
|
void | operator= (const Foam::zero) |
| Assignment of all entries to zero. More...
|
|
void | operator= (List< Type > &&list) |
| Move assignment. Takes constant time. More...
|
|
void | operator= (DynamicList< Type, SizeMin > &&list) |
| Move assignment. Takes constant time. More...
|
|
void | operator= (SLList< Type > &&list) |
| Move assignment. Takes constant time. More...
|
|
Istream & | readList (Istream &is) |
| Read List from Istream, discarding contents of existing List. More...
|
|
Istream & | readList (Istream &is) |
| Specialized list reading for character lists which always uses binary format. More...
|
|
Istream & | readList (Istream &is) |
|
void | shallowCopy (const UList< Type > &)=delete |
| No shallowCopy permitted. More...
|
|
std::enable_if< std::is_same< bool, TypeT >::value, bool >::type | set (const label i, bool val=true) |
| A bitSet::set() method for a list of bool. More...
|
|
void | append (const Type &val) |
| Append an element at the end of the list. More...
|
|
void | append (Type &&val) |
| Move append an element at the end of the list. More...
|
|
void | append (const UList< Type > &list) |
| Append a List to the end of this list. More...
|
|
void | append (const IndirectListBase< Type, Addr > &list) |
| Append IndirectList contents at the end of this list. More...
|
|
label | appendUniq (const Type &val) |
| Append an element if not already in the list. More...
|
|
label | size () const noexcept |
| The number of elements in the UList. More...
|
|
void | writeEntry (const word &keyword, Ostream &os) const |
| Write the List as a dictionary entry with keyword. More...
|
|
void | operator= (const Type &val) |
| Assignment of all entries to the given value. More...
|
|
void | operator= (const Foam::zero) |
| Assignment of all entries to zero. More...
|
|
| UList (const UList< Type > &)=default |
| Copy construct. More...
|
|
constexpr | UList () noexcept |
| Default construct, zero-sized and nullptr. More...
|
|
| UList (Type *__restrict__ v, const label len) noexcept |
| Construct from components. More...
|
|
label | fcIndex (const label i) const noexcept |
| The forward circular index. The next index in the list which returns to the first at the end of the list. More...
|
|
label | rcIndex (const label i) const noexcept |
| The reverse circular index. The previous index in the list which returns to the last at the beginning of the list. More...
|
|
const Type & | fcValue (const label i) const |
| Return forward circular value (ie, next value in the list) More...
|
|
Type & | fcValue (const label i) |
| Return forward circular value (ie, next value in the list) More...
|
|
const Type & | rcValue (const label i) const |
| Return reverse circular value (ie, previous value in the list) More...
|
|
Type & | rcValue (const label i) |
| Return reverse circular value (ie, previous value in the list) More...
|
|
const Type * | cdata () const noexcept |
| Return pointer to the underlying array serving as data storage. More...
|
|
Type * | data () noexcept |
| Return pointer to the underlying array serving as data storage. More...
|
|
const char * | cdata_bytes () const noexcept |
| Return pointer to the underlying array serving as data storage,. More...
|
|
char * | data_bytes () noexcept |
| Return pointer to the underlying array serving as data storage,. More...
|
|
Type & | front () |
| Access first element of the list, position [0]. More...
|
|
const Type & | front () const |
| Access first element of the list. More...
|
|
Type & | back () |
| Access last element of the list, position [size()-1]. More...
|
|
const Type & | back () const |
| Access last element of the list, position [size()-1]. More...
|
|
std::streamsize | size_bytes () const noexcept |
| Number of contiguous bytes for the List data. More...
|
|
std::streamsize | byteSize () const |
| Number of contiguous bytes for the List data, runtime FatalError if type is not contiguous. More...
|
|
void | checkStart (const label start) const |
| Check start is within valid range [0,size) More...
|
|
void | checkSize (const label size) const |
| Check size is within valid range [0,size]. More...
|
|
void | checkRange (const label start, const label len) const |
| Check that start and length define a valid range. More...
|
|
void | checkIndex (const label i) const |
| Check index is within valid range [0,size) More...
|
|
bool | uniform () const |
| True if all entries have identical values, and list is non-empty. More...
|
|
label | find (const Type &val, label pos=0) const |
| Find index of the first occurrence of the value. More...
|
|
label | rfind (const Type &val, label pos=-1) const |
| Find index of the last occurrence of the value. More...
|
|
bool | found (const Type &val, label pos=0) const |
| True if the value if found in the list. More...
|
|
void | moveFirst (const label i) |
| Move element to the first position. More...
|
|
void | moveLast (const label i) |
| Move element to the last position. More...
|
|
void | swapFirst (const label i) |
| Swap element with the first element. Fatal on an empty list. More...
|
|
void | swapLast (const label i) |
| Swap element with the last element. Fatal on an empty list. More...
|
|
void | shallowCopy (const UList< Type > &list) |
| Copy the pointer and size held by the given UList. More...
|
|
void | deepCopy (const UList< Type > &list) |
| Copy elements of the given UList. Sizes must match! More...
|
|
void | deepCopy (const IndirectListBase< Type, Addr > &list) |
| Copy elements of the given indirect list. Sizes must match! More...
|
|
SubList< Type > | slice (const label pos, label len=-1) |
| Return SubList slice (non-const access) - no range checking. More...
|
|
const SubList< Type > | slice (const label pos, label len=-1) const |
| Return SubList slice (const access) - no range checking. More...
|
|
SubList< Type > | slice (const labelRange &range) |
| Return SubList slice (non-const access) - with range checking. More...
|
|
const SubList< Type > | slice (const labelRange &range) const |
| Return SubList slice (const access) - with range checking. More...
|
|
Type & | operator[] (const label i) |
| Return element of UList. More...
|
|
const Type & | operator[] (const label i) const |
| Return element of constant UList. More...
|
|
const bool & | operator[] (const label i) const |
|
Foam::UPstream::commsStruct & | operator[] (const label procID) |
|
const Foam::UPstream::commsStruct & | operator[] (const label procID) const |
|
UPstream::commsStruct & | operator[] (const label procID) |
|
const UPstream::commsStruct & | operator[] (const label procID) const |
|
| operator const Foam::List< Type > & () const |
| Allow cast to a const List<T>&. More...
|
|
iterator | begin () noexcept |
| Return an iterator to begin traversing the UList. More...
|
|
const_iterator | begin () const noexcept |
| Return const_iterator to begin traversing the constant UList. More...
|
|
iterator | end () noexcept |
| Return an iterator to end traversing the UList. More...
|
|
const_iterator | end () const noexcept |
| Return const_iterator to end traversing the constant UList. More...
|
|
const_iterator | cbegin () const noexcept |
| Return const_iterator to begin traversing the constant UList. More...
|
|
const_iterator | cend () const noexcept |
| Return const_iterator to end traversing the constant UList. More...
|
|
reverse_iterator | rbegin () |
| Return reverse_iterator to begin reverse traversing the UList. More...
|
|
const_reverse_iterator | rbegin () const |
| Return const_reverse_iterator to begin reverse traversing the UList. More...
|
|
reverse_iterator | rend () |
| Return reverse_iterator to end reverse traversing the UList. More...
|
|
const_reverse_iterator | rend () const |
| Return const_reverse_iterator to end reverse traversing the UList. More...
|
|
const_reverse_iterator | crbegin () const |
| Return const_reverse_iterator to begin reverse traversing the UList. More...
|
|
const_reverse_iterator | crend () const |
| Return const_reverse_iterator to end reverse traversing the UList. More...
|
|
bool | empty () const noexcept |
| True if the UList is empty (ie, size() is zero) More...
|
|
void | swap (UList< Type > &list) |
| Swap content with another UList of the same type in constant time. More...
|
|
bool | operator== (const UList< Type > &a) const |
| Equality operation on ULists of the same type. More...
|
|
bool | operator!= (const UList< Type > &a) const |
| The opposite of the equality operation. Takes linear time. More...
|
|
bool | operator< (const UList< Type > &list) const |
| Compare two ULists lexicographically. Takes linear time. More...
|
|
bool | operator> (const UList< Type > &a) const |
| Compare two ULists lexicographically. Takes linear time. More...
|
|
bool | operator<= (const UList< Type > &a) const |
| Return true if !(a > b). Takes linear time. More...
|
|
bool | operator>= (const UList< Type > &a) const |
| Return true if !(a < b). Takes linear time. More...
|
|
Istream & | readList (Istream &is) |
| Read List contents from Istream. More...
|
|
Istream & | readList (Istream &is) |
| Specialized list reading for character lists which always uses binary format. More...
|
|
Istream & | readList (Istream &is) |
|
Ostream & | writeList (Ostream &os, const label shortLen=0) const |
| Write List, with line-breaks in ASCII when length exceeds shortLen. More...
|
|
Ostream & | writeList (Ostream &os, const label) const |
| Specialized writeList for character lists which always uses binary format. More...
|
|
Ostream & | writeList (Ostream &os, const label) const |
|
std::enable_if< std::is_same< bool, TypeT >::value, bool >::type | test (const label i) const |
| Test bool value at specified position, always false for out-of-range access. More...
|
|
std::enable_if< std::is_same< bool, TypeT >::value, bool >::type | get (const label i) const |
| Return bool value at specified position, always false for out-of-range access. More...
|
|
std::enable_if< std::is_same< bool, TypeT >::value, bool >::type | unset (const label i) |
| Unset the bool entry at specified position, always false for out-of-range access. More...
|
|
Type & | first () |
| Access first element of the list, position [0]. More...
|
|
const Type & | first () const |
| Access first element of the list. More...
|
|
Type & | last () |
| Access last element of the list, position [size()-1]. More...
|
|
const Type & | last () const |
| Access last element of the list, position [size()-1]. More...
|
|
| TypeName ("transportModel") |
| Runtime type information. More...
|
|
| transportModel () |
| Construct from components. More...
|
|
virtual | ~transportModel () |
| Destructor. More...
|
|