specieTransferMassFractionFvPatchScalarField Class Referenceabstract

Abstract base class for specie-transferring mass fraction boundary conditions. More...

Inheritance diagram for specieTransferMassFractionFvPatchScalarField:
Collaboration diagram for specieTransferMassFractionFvPatchScalarField:

Public Types

enum  property { massFraction, moleFraction, molarConcentration, partialPressure }
 Enumeration for the property driving the transfer. More...
 

Public Member Functions

 specieTransferMassFractionFvPatchScalarField (const fvPatch &, const DimensionedField< scalar, volMesh > &)
 Construct from patch and internal field. More...
 
 specieTransferMassFractionFvPatchScalarField (const fvPatch &, const DimensionedField< scalar, volMesh > &, const dictionary &)
 Construct from patch, internal field and dictionary. More...
 
 specieTransferMassFractionFvPatchScalarField (const specieTransferMassFractionFvPatchScalarField &, const fvPatch &, const DimensionedField< scalar, volMesh > &, const fvPatchFieldMapper &)
 Construct by mapping given fixedValueTypeFvPatchField. More...
 
 specieTransferMassFractionFvPatchScalarField (const specieTransferMassFractionFvPatchScalarField &)=delete
 Disallow copy without setting internal field reference. More...
 
 specieTransferMassFractionFvPatchScalarField (const specieTransferMassFractionFvPatchScalarField &, const DimensionedField< scalar, volMesh > &)
 Copy constructor setting internal field reference. More...
 
virtual void autoMap (const fvPatchFieldMapper &)
 Map (and resize as needed) from self given a mapping object. More...
 
virtual void rmap (const fvPatchScalarField &, const labelList &)
 Reverse map the given fvPatchField onto this fvPatchField. More...
 
virtual tmp< scalarFieldcalcPhiYp () const =0
 Return the flux of this species. More...
 
virtual const scalarFieldphiYp () const
 Return the flux of this species. More...
 
virtual void updateCoeffs ()
 Update the coefficients associated with the patch field. More...
 
virtual void write (Ostream &) const
 Write. More...
 

Static Public Member Functions

static const basicSpecieMixturecomposition (const objectRegistry &db)
 Access the composition for the given database. More...
 

Static Public Attributes

static const NamedEnum< property, 4 > propertyNames_
 Property type names. More...
 

Protected Attributes

const scalar c_
 Transfer coefficient. More...
 
const property property_
 Property driving the transfer. More...
 

Detailed Description

Abstract base class for specie-transferring mass fraction boundary conditions.

Derived classes compute the actual species flux. Those fluxes are summed up by the specieTransferVelocityFvPatchVectorField velocity condition to generate the net mass transfer into or out of the patch. This mass-fraction condition then generates a corrective diffusive flux to ensure that the correct amounts of the transferring species are transported through the patch.

Source files

Definition at line 58 of file specieTransferMassFractionFvPatchScalarField.H.

Member Enumeration Documentation

◆ property

enum property

Enumeration for the property driving the transfer.

Enumerator
massFraction 
moleFraction 
molarConcentration 
partialPressure 

Definition at line 65 of file specieTransferMassFractionFvPatchScalarField.H.

Constructor & Destructor Documentation

◆ specieTransferMassFractionFvPatchScalarField() [1/5]

Construct from patch and internal field.

Definition at line 76 of file specieTransferMassFractionFvPatchScalarField.C.

References Foam::Zero.

Referenced by specieTransferMassFractionFvPatchScalarField::composition(), and specieTransferMassFractionFvPatchScalarField::specieTransferMassFractionFvPatchScalarField().

Here is the caller graph for this function:

◆ specieTransferMassFractionFvPatchScalarField() [2/5]

specieTransferMassFractionFvPatchScalarField ( const fvPatch p,
const DimensionedField< scalar, volMesh > &  iF,
const dictionary dict 
)

Construct from patch, internal field and dictionary.

Definition at line 97 of file specieTransferMassFractionFvPatchScalarField.C.

References fvPatchField< Type >::operator=(), fvPatch::size(), specieTransferMassFractionFvPatchScalarField::specieTransferMassFractionFvPatchScalarField(), and Foam::Zero.

Here is the call graph for this function:

◆ specieTransferMassFractionFvPatchScalarField() [3/5]

Construct by mapping given fixedValueTypeFvPatchField.

onto a new patch

Definition at line 126 of file specieTransferMassFractionFvPatchScalarField.C.

References specieTransferMassFractionFvPatchScalarField::specieTransferMassFractionFvPatchScalarField().

Here is the call graph for this function:

◆ specieTransferMassFractionFvPatchScalarField() [4/5]

Disallow copy without setting internal field reference.

◆ specieTransferMassFractionFvPatchScalarField() [5/5]

Copy constructor setting internal field reference.

Definition at line 145 of file specieTransferMassFractionFvPatchScalarField.C.

References specieTransferMassFractionFvPatchScalarField::autoMap().

Here is the call graph for this function:

Member Function Documentation

◆ composition()

◆ autoMap()

void autoMap ( const fvPatchFieldMapper m)
virtual

Map (and resize as needed) from self given a mapping object.

Used to update fields following mesh topology change

Definition at line 163 of file specieTransferMassFractionFvPatchScalarField.C.

References specieTransferMassFractionFvPatchScalarField::rmap().

Referenced by specieTransferMassFractionFvPatchScalarField::specieTransferMassFractionFvPatchScalarField().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ rmap()

void rmap ( const fvPatchScalarField ptf,
const labelList addr 
)
virtual

Reverse map the given fvPatchField onto this fvPatchField.

Used to reconstruct fields

Definition at line 174 of file specieTransferMassFractionFvPatchScalarField.C.

References specieTransferMassFractionFvPatchScalarField::rmap().

Referenced by specieTransferMassFractionFvPatchScalarField::autoMap(), and specieTransferMassFractionFvPatchScalarField::rmap().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ calcPhiYp()

virtual tmp<scalarField> calcPhiYp ( ) const
pure virtual

◆ phiYp()

const Foam::scalarField & phiYp ( ) const
virtual

Return the flux of this species.

Definition at line 189 of file specieTransferMassFractionFvPatchScalarField.C.

References objectRegistry::time(), timeIndex, and TimeState::timeIndex().

Here is the call graph for this function:

◆ updateCoeffs()

void updateCoeffs ( )
virtual

Update the coefficients associated with the patch field.

Definition at line 202 of file specieTransferMassFractionFvPatchScalarField.C.

References specieTransferMassFractionFvPatchScalarField::write().

Here is the call graph for this function:

◆ write()

Member Data Documentation

◆ propertyNames_

◆ c_

◆ property_


The documentation for this class was generated from the following files: