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:
Collaboration diagram for mappedFlowRateFvPatchVectorField:

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 this_bctype &, const fvPatch &, const DimensionedField< vector, volMesh > &, const fvPatchFieldMapper &)
 Construct by mapping onto a new patch. More...
 
 mappedFlowRateFvPatchVectorField (const this_bctype &, const DimensionedField< vector, volMesh > &)
 Construct as copy setting internal field reference. More...
 
 mappedFlowRateFvPatchVectorField (const this_bctype &)=delete
 No copy without an internal field. More...
 
virtual tmp< fvPatchField< vector > > clone (const DimensionedField< vector, volMesh > &iF) const
 Clone with an 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 95 of file mappedFlowRateFvPatchVectorField.H.

Constructor & Destructor Documentation

◆ mappedFlowRateFvPatchVectorField() [1/5]

Construct from patch and internal field.

◆ mappedFlowRateFvPatchVectorField() [2/5]

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

Construct from patch, internal field and dictionary.

◆ mappedFlowRateFvPatchVectorField() [3/5]

mappedFlowRateFvPatchVectorField ( const this_bctype ,
const fvPatch ,
const DimensionedField< vector, volMesh > &  ,
const fvPatchFieldMapper  
)

Construct by mapping onto a new patch.

◆ mappedFlowRateFvPatchVectorField() [4/5]

Construct as copy setting internal field reference.

◆ mappedFlowRateFvPatchVectorField() [5/5]

No copy without an internal field.

Member Function Documentation

◆ TypeName()

TypeName ( "mappedFlowRate"  )

Runtime type information.

◆ clone()

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

Clone with an internal field reference.

Definition at line 178 of file mappedFlowRateFvPatchVectorField.H.

References fvPatchField< Type >::Clone().

Here is the call graph for this function:

◆ updateCoeffs()

virtual void updateCoeffs ( )
virtual

Update the coefficients associated with the patch field.

◆ write()

virtual void write ( Ostream ) const
virtual

Write.


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