mappedFlowRateFvPatchVectorField Class Reference

Describes a volumetric/mass flow normal vector boundary condition by its magnitude as an integral over its area. More...

Inheritance diagram for mappedFlowRateFvPatchVectorField:
[legend]
Collaboration diagram for mappedFlowRateFvPatchVectorField:
[legend]

Public Member Functions

 TypeName ("mappedFlowRate")
 Runtime type information. More...
 
 mappedFlowRateFvPatchVectorField (const fvPatch &, const DimensionedField< vector, volMesh > &)
 Construct from patch and internal field. More...
 
 mappedFlowRateFvPatchVectorField (const fvPatch &, const DimensionedField< vector, volMesh > &, const dictionary &)
 Construct from patch, internal field and dictionary. More...
 
 mappedFlowRateFvPatchVectorField (const mappedFlowRateFvPatchVectorField &, const fvPatch &, const DimensionedField< vector, volMesh > &, const fvPatchFieldMapper &)
 Construct by mapping given. More...
 
 mappedFlowRateFvPatchVectorField (const mappedFlowRateFvPatchVectorField &)
 Construct as copy. More...
 
virtual tmp< fvPatchVectorFieldclone () const
 Construct and return a clone. More...
 
 mappedFlowRateFvPatchVectorField (const mappedFlowRateFvPatchVectorField &, const DimensionedField< vector, volMesh > &)
 Construct as copy setting internal field reference. More...
 
virtual tmp< fvPatchVectorFieldclone (const DimensionedField< vector, volMesh > &iF) const
 Construct and return a clone setting internal field reference. More...
 
virtual void updateCoeffs ()
 Update the coefficients associated with the patch field. More...
 
virtual void write (Ostream &) const
 Write. More...
 

Detailed Description

Describes a volumetric/mass flow normal vector boundary condition by its magnitude as an integral over its area.

The inlet mass flux is taken from the neighbour region.

The basis of the patch (volumetric or mass) is determined by the dimensions of the flux, phi. The current density is used to correct the velocity when applying the mass basis.

Usage
Property Description Required Default value
phi flux field name no phi
rho density field name no rho
neigPhi name of flux field on neighbour mesh yes

Example of the boundary condition specification:

    <patchName>
    {
        type            mappedFlowRate;
        phi             phi;
        rho             rho;
        neigPhi         phi;
        value           uniform (0 0 0); // placeholder
    }
Source files

Definition at line 99 of file mappedFlowRateFvPatchVectorField.H.

Constructor & Destructor Documentation

◆ mappedFlowRateFvPatchVectorField() [1/5]

Construct from patch and internal field.

Definition at line 38 of file mappedFlowRateFvPatchVectorField.C.

◆ mappedFlowRateFvPatchVectorField() [2/5]

mappedFlowRateFvPatchVectorField ( const fvPatch p,
const DimensionedField< vector, volMesh > &  iF,
const dictionary dict 
)

Construct from patch, internal field and dictionary.

Definition at line 66 of file mappedFlowRateFvPatchVectorField.C.

◆ mappedFlowRateFvPatchVectorField() [3/5]

Construct by mapping given.

mappedFlowRateFvPatchVectorField onto a new patch

Definition at line 51 of file mappedFlowRateFvPatchVectorField.C.

◆ mappedFlowRateFvPatchVectorField() [4/5]

Construct as copy.

Definition at line 80 of file mappedFlowRateFvPatchVectorField.C.

◆ mappedFlowRateFvPatchVectorField() [5/5]

Construct as copy setting internal field reference.

Definition at line 92 of file mappedFlowRateFvPatchVectorField.C.

Member Function Documentation

◆ TypeName()

TypeName ( "mappedFlowRate"  )

Runtime type information.

◆ clone() [1/2]

virtual tmp< fvPatchVectorField > clone ( ) const
inlinevirtual

Construct and return a clone.

Definition at line 156 of file mappedFlowRateFvPatchVectorField.H.

◆ 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 172 of file mappedFlowRateFvPatchVectorField.H.

◆ updateCoeffs()

◆ write()

void write ( Ostream os) const
virtual

Write.

Definition at line 186 of file mappedFlowRateFvPatchVectorField.C.

References os(), ObukhovLength::write(), Ostream::writeEntry(), and Ostream::writeEntryIfDifferent().

Here is the call graph for this function:

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