Public Member Functions | List of all members
specieTransferVelocityFvPatchVectorField Class Reference

This is a velocity boundary condition for a specie-transferring wall. More...

Inheritance diagram for specieTransferVelocityFvPatchVectorField:
Inheritance graph
[legend]
Collaboration diagram for specieTransferVelocityFvPatchVectorField:
Collaboration graph
[legend]

Public Member Functions

 TypeName ("specieTransferVelocity")
 Runtime type information. More...
 
 specieTransferVelocityFvPatchVectorField (const fvPatch &, const DimensionedField< vector, volMesh > &)
 Construct from patch and internal field. More...
 
 specieTransferVelocityFvPatchVectorField (const fvPatch &, const DimensionedField< vector, volMesh > &, const dictionary &, const bool readValue=true)
 Construct from patch, internal field and dictionary. More...
 
 specieTransferVelocityFvPatchVectorField (const specieTransferVelocityFvPatchVectorField &, const fvPatch &, const DimensionedField< vector, volMesh > &, const fvPatchFieldMapper &)
 Construct by mapping given fixedValueTypeFvPatchField. More...
 
 specieTransferVelocityFvPatchVectorField (const specieTransferVelocityFvPatchVectorField &)
 Copy constructor. More...
 
virtual tmp< fvPatchVectorField > clone () const
 Construct and return a clone. More...
 
 specieTransferVelocityFvPatchVectorField (const specieTransferVelocityFvPatchVectorField &, const DimensionedField< vector, volMesh > &)
 Copy constructor setting internal field reference. More...
 
virtual tmp< fvPatchVectorField > clone (const DimensionedField< vector, volMesh > &iF) const
 Construct and return a clone setting internal field reference. More...
 
const tmp< scalarField > phip () const
 Return the flux. More...
 
virtual void updateCoeffs ()
 Update the coefficients associated with the patch field. More...
 
virtual void write (Ostream &) const
 Write. More...
 

Detailed Description

This is a velocity boundary condition for a specie-transferring wall.

This condition must be used in conjunction with mass-fraction boundary conditions derived from specieTransferMassFractionFvPatchScalarField, and a specieTransferTemperature condition for the temperature.

This condition sums the species' mass fluxes generated by the mass-fraction conditions, and uses this total to set the normal velocity into or out of the wall.

Usage
Property Description Req'd? Default
rho Name of the density field no rho

Example of the boundary condition specification: 

    <patchName>
    {
        type            specieTransferVelocity;
        value           $internalField;
    }
See also
Foam::specieTransferMassFractionFvPatchScalarField Foam::specieTransferTemperatureFvPatchScalarField
Source files

Definition at line 85 of file specieTransferVelocityFvPatchVectorField.H.

Constructor & Destructor Documentation

◆ specieTransferVelocityFvPatchVectorField() [1/5]

specieTransferVelocityFvPatchVectorField ( const fvPatch &  p,
const DimensionedField< vector, volMesh > &  iF 
)

Construct from patch and internal field.

Definition at line 38 of file specieTransferVelocityFvPatchVectorField.C.

Referenced by specieTransferVelocityFvPatchVectorField::clone(), and specieTransferVelocityFvPatchVectorField::specieTransferVelocityFvPatchVectorField().

Here is the caller graph for this function:

◆ specieTransferVelocityFvPatchVectorField() [2/5]

specieTransferVelocityFvPatchVectorField ( const fvPatch &  p,
const DimensionedField< vector, volMesh > &  iF,
const dictionary &  dict,
const bool  readValue = true 
)

Construct from patch, internal field and dictionary.

Definition at line 50 of file specieTransferVelocityFvPatchVectorField.C.

References Foam::operator==(), fvPatch::size(), specieTransferVelocityFvPatchVectorField::specieTransferVelocityFvPatchVectorField(), and vectorField().

Here is the call graph for this function:

◆ specieTransferVelocityFvPatchVectorField() [3/5]

specieTransferVelocityFvPatchVectorField ( const specieTransferVelocityFvPatchVectorField &  ptf,
const fvPatch &  p,
const DimensionedField< vector, volMesh > &  iF,
const fvPatchFieldMapper &  mapper 
)

Construct by mapping given fixedValueTypeFvPatchField.

onto a new patch

Definition at line 69 of file specieTransferVelocityFvPatchVectorField.C.

References specieTransferVelocityFvPatchVectorField::specieTransferVelocityFvPatchVectorField().

Here is the call graph for this function:

◆ specieTransferVelocityFvPatchVectorField() [4/5]

specieTransferVelocityFvPatchVectorField ( const specieTransferVelocityFvPatchVectorField &  ptf)

Copy constructor.

Definition at line 83 of file specieTransferVelocityFvPatchVectorField.C.

References specieTransferVelocityFvPatchVectorField::specieTransferVelocityFvPatchVectorField().

Here is the call graph for this function:

◆ specieTransferVelocityFvPatchVectorField() [5/5]

specieTransferVelocityFvPatchVectorField ( const specieTransferVelocityFvPatchVectorField &  ptf,
const DimensionedField< vector, volMesh > &  iF 
)

Copy constructor setting internal field reference.

Definition at line 94 of file specieTransferVelocityFvPatchVectorField.C.

Member Function Documentation

◆ TypeName()

TypeName ( "specieTransferVelocity"  )

Runtime type information.

◆ clone() [1/2]

virtual tmp<fvPatchVectorField> clone ( ) const
inlinevirtual

Construct and return a clone.

Definition at line 136 of file specieTransferVelocityFvPatchVectorField.H.

References specieTransferVelocityFvPatchVectorField::specieTransferVelocityFvPatchVectorField().

Here is the call graph for this function:

◆ clone() [2/2]

virtual tmp<fvPatchVectorField> clone ( const DimensionedField< vector, volMesh > &  iF) const
inlinevirtual

Construct and return a clone setting internal field reference.

Definition at line 153 of file specieTransferVelocityFvPatchVectorField.H.

References specieTransferVelocityFvPatchVectorField::phip(), specieTransferVelocityFvPatchVectorField::specieTransferVelocityFvPatchVectorField(), specieTransferVelocityFvPatchVectorField::updateCoeffs(), and specieTransferVelocityFvPatchVectorField::write().

Here is the call graph for this function:

◆ phip()

const Foam::tmp< Foam::scalarField > phip ( ) const

Return the flux.

Definition at line 107 of file specieTransferVelocityFvPatchVectorField.C.

References composition, Foam::exit(), Foam::FatalError, FatalErrorInFunction, forAll, tmp< T >::ref(), and Y.

Referenced by specieTransferVelocityFvPatchVectorField::clone(), and specieTransferVelocityFvPatchVectorField::updateCoeffs().

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

◆ updateCoeffs()

void updateCoeffs ( )
virtual

Update the coefficients associated with the patch field.

Definition at line 134 of file specieTransferVelocityFvPatchVectorField.C.

References Tensor< scalar >::I, Foam::operator==(), specieTransferVelocityFvPatchVectorField::phip(), Foam::sqr(), and specieTransferVelocityFvPatchVectorField::write().

Referenced by specieTransferVelocityFvPatchVectorField::clone().

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

◆ write()

void write ( Ostream &  os) const
virtual

Write.

Definition at line 155 of file specieTransferVelocityFvPatchVectorField.C.

References Foam::makePatchTypeField(), fvPatchField< Type >::write(), and Foam::writeEntry().

Referenced by specieTransferVelocityFvPatchVectorField::clone(), and specieTransferVelocityFvPatchVectorField::updateCoeffs().

Here is the call graph for this function:
Here is the caller graph for this function:
The documentation for this class was generated from the following files: