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 > &, 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. 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 map (const fvPatchScalarField &, const fvPatchFieldMapper &)
 Map the given fvPatchField onto this fvPatchField. More...
 
virtual void reset (const fvPatchScalarField &)
 Reset the fvPatchField to the given 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/4]

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

Construct from patch, internal field and dictionary.

Definition at line 74 of file specieTransferMassFractionFvPatchScalarField.C.

References dict, fvPatchField< Type >::operator=(), p, and Foam::Zero.

Here is the call graph for this function:

◆ specieTransferMassFractionFvPatchScalarField() [2/4]

Construct by mapping given.

specieTransferMassFractionFvPatchScalarField onto a new patch

Definition at line 103 of file specieTransferMassFractionFvPatchScalarField.C.

◆ specieTransferMassFractionFvPatchScalarField() [3/4]

Disallow copy without setting internal field reference.

◆ specieTransferMassFractionFvPatchScalarField() [4/4]

Copy constructor setting internal field reference.

Definition at line 122 of file specieTransferMassFractionFvPatchScalarField.C.

Member Function Documentation

◆ composition()

const Foam::basicSpecieMixture & composition ( const objectRegistry db)
static

Access the composition for the given database.

Definition at line 61 of file specieTransferMassFractionFvPatchScalarField.C.

References objectRegistry::lookupObject(), and Foam::name().

Here is the call graph for this function:

◆ map()

void map ( const fvPatchScalarField ptf,
const fvPatchFieldMapper mapper 
)
virtual

Map the given fvPatchField onto this fvPatchField.

Definition at line 141 of file specieTransferMassFractionFvPatchScalarField.C.

◆ reset()

void reset ( const fvPatchScalarField ptf)
virtual

Reset the fvPatchField to the given fvPatchField.

Used for mesh to mesh mapping

Definition at line 156 of file specieTransferMassFractionFvPatchScalarField.C.

◆ calcPhiYp()

virtual tmp<scalarField> calcPhiYp ( ) const
pure virtual

◆ phiYp()

const Foam::scalarField & phiYp ( ) const
virtual

Return the flux of this species.

Definition at line 171 of file specieTransferMassFractionFvPatchScalarField.C.

References timeIndex.

◆ updateCoeffs()

void updateCoeffs ( )
virtual

Update the coefficients associated with the patch field.

Definition at line 184 of file specieTransferMassFractionFvPatchScalarField.C.

References GeometricField< Type, PatchField, GeoMesh >::boundaryField(), basicThermo::Cp(), thermophysicalTransportModel::kappaEff(), and fluidThermophysicalTransportModel::thermo().

Here is the call graph for this function:

◆ write()

void write ( Ostream os) const
virtual

Member Data Documentation

◆ propertyNames_

Property type names.

Definition at line 74 of file specieTransferMassFractionFvPatchScalarField.H.

◆ c_

const scalar c_
protected

Transfer coefficient.

Definition at line 99 of file specieTransferMassFractionFvPatchScalarField.H.

◆ property_

const property property_
protected

Property driving the transfer.

Definition at line 102 of file specieTransferMassFractionFvPatchScalarField.H.


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