adsorptionMassFractionFvPatchScalarField Class Reference

This is a mass-fraction boundary condition for an adsorbing wall. More...

Inheritance diagram for adsorptionMassFractionFvPatchScalarField:
Collaboration diagram for adsorptionMassFractionFvPatchScalarField:

Public Member Functions

 TypeName ("adsorptionMassFraction")
 Runtime type information. More...
 
 adsorptionMassFractionFvPatchScalarField (const fvPatch &, const DimensionedField< scalar, volMesh > &, const dictionary &)
 Construct from patch, internal field and dictionary. More...
 
 adsorptionMassFractionFvPatchScalarField (const adsorptionMassFractionFvPatchScalarField &, const fvPatch &, const DimensionedField< scalar, volMesh > &, const fvPatchFieldMapper &)
 Construct by mapping given fixedValueTypeFvPatchField. More...
 
 adsorptionMassFractionFvPatchScalarField (const adsorptionMassFractionFvPatchScalarField &)=delete
 Disallow copy without setting internal field reference. More...
 
 adsorptionMassFractionFvPatchScalarField (const adsorptionMassFractionFvPatchScalarField &, const DimensionedField< scalar, volMesh > &)
 Copy constructor setting internal field reference. More...
 
virtual tmp< fvPatchScalarFieldclone (const DimensionedField< scalar, volMesh > &iF) const
 Construct and return a clone setting internal field reference. More...
 
tmp< scalarFieldcalcPhiYp () const
 Return the flux of this species. More...
 
virtual void write (Ostream &) const
 Write. More...
 
- Public Member Functions inherited from specieTransferMassFractionFvPatchScalarField
 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 const scalarFieldphiYp () const
 Return the flux of this species. More...
 
virtual void updateCoeffs ()
 Update the coefficients associated with the patch field. More...
 

Additional Inherited Members

- Public Types inherited from specieTransferMassFractionFvPatchScalarField
enum  property { massFraction , moleFraction , molarConcentration , partialPressure }
 Enumeration for the property driving the transfer. More...
 
- Static Public Member Functions inherited from specieTransferMassFractionFvPatchScalarField
static const basicSpecieMixturecomposition (const objectRegistry &db)
 Access the composition for the given database. More...
 
- Static Public Attributes inherited from specieTransferMassFractionFvPatchScalarField
static const NamedEnum< property, 4 > propertyNames_
 Property type names. More...
 
- Protected Attributes inherited from specieTransferMassFractionFvPatchScalarField
const scalar c_
 Transfer coefficient. More...
 
const property property_
 Property driving the transfer. More...
 

Detailed Description

This is a mass-fraction boundary condition for an adsorbing wall.

This condition models a baffle which adsorbs some species and not others. It must be used in conjunction with a specieTransferVelocityFvPatchVectorField velocity condition, and a specieTransferTemperatureFvPatchScalarField temperature condition.

The mass flux of a species is calculated as a coefficient multiplied by the concentration adjacent to the patch.

\[ \phi_{Yi} = c A \psi_i \]

where

$ \phi_{Yi} $ = Flux of the adsorbing specie [kg/s]
$ c $ = Transfer coefficient [kg/m^2/s/<property-dimensions>]
$ A $ = Patch face area [m^2]
$ C_i $ = Property adjacent to the patch [<property-dimensions>]

A species that is adsorbed by the patch will, therefore, have a coefficient greater than zero, whilst a species that is not adsorbed will have a coefficient equal to zero.

Usage
Property Description Req'd? Default
c Transfer coefficient no 0
property Property used to drive the transfer; massFraction, moleFraction, molarConcentration, or partialPressure if c is non-zero
phi Name of the flux field no phi
U Name of the velocity field no U

Example of the boundary condition specification:

    <patchName>
    {
        type            adsorptionMassFraction;
        property        molarConcentration;
        c               1e-3;
        value           $internalField;
    }
See also
Foam::specieTransferMassFractionFvPatchScalarField Foam::specieTransferVelocityFvPatchVectorField Foam::specieTransferTemperatureFvPatchScalarField
Source files

Definition at line 138 of file adsorptionMassFractionFvPatchScalarField.H.

Constructor & Destructor Documentation

◆ adsorptionMassFractionFvPatchScalarField() [1/4]

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

Construct from patch, internal field and dictionary.

Definition at line 35 of file adsorptionMassFractionFvPatchScalarField.C.

◆ adsorptionMassFractionFvPatchScalarField() [2/4]

Construct by mapping given fixedValueTypeFvPatchField.

onto a new patch

Definition at line 47 of file adsorptionMassFractionFvPatchScalarField.C.

◆ adsorptionMassFractionFvPatchScalarField() [3/4]

Disallow copy without setting internal field reference.

◆ adsorptionMassFractionFvPatchScalarField() [4/4]

Copy constructor setting internal field reference.

Definition at line 60 of file adsorptionMassFractionFvPatchScalarField.C.

Member Function Documentation

◆ TypeName()

TypeName ( "adsorptionMassFraction"  )

Runtime type information.

◆ clone()

virtual tmp<fvPatchScalarField> clone ( const DimensionedField< scalar, volMesh > &  iF) const
inlinevirtual

Construct and return a clone setting internal field reference.

Definition at line 183 of file adsorptionMassFractionFvPatchScalarField.H.

◆ calcPhiYp()

◆ write()

void write ( Ostream os) const
virtual

Write.

Reimplemented from specieTransferMassFractionFvPatchScalarField.

Definition at line 146 of file adsorptionMassFractionFvPatchScalarField.C.

References specieTransferMassFractionFvPatchScalarField::write(), and Foam::writeEntry().

Here is the call graph for this function:

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