Loading...
Searching...
No Matches
mappedFlowRateFvPatchVectorField Class Reference
Boundary conditions » Inlet | Boundary conditions » Coupled

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

#include <mappedFlowRateFvPatchVectorField.H>

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

Public Member Functions

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

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]

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

Construct from patch and internal field.

Definition at line 31 of file mappedFlowRateFvPatchVectorField.C.

References p.

Referenced by mappedFlowRateFvPatchVectorField(), mappedFlowRateFvPatchVectorField(), mappedFlowRateFvPatchVectorField(), and TypeName().

Here is the caller graph for this function:

◆ 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 59 of file mappedFlowRateFvPatchVectorField.C.

References dict, and p.

◆ mappedFlowRateFvPatchVectorField() [3/5]

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

Construct by mapping given.

mappedFlowRateFvPatchVectorField onto a new patch

Definition at line 44 of file mappedFlowRateFvPatchVectorField.C.

References mappedFlowRateFvPatchVectorField(), and p.

Here is the call graph for this function:

◆ mappedFlowRateFvPatchVectorField() [4/5]

mappedFlowRateFvPatchVectorField ( const mappedFlowRateFvPatchVectorField & ptf)

Construct as copy.

Definition at line 73 of file mappedFlowRateFvPatchVectorField.C.

References mappedFlowRateFvPatchVectorField().

Here is the call graph for this function:

◆ mappedFlowRateFvPatchVectorField() [5/5]

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

Construct as copy setting internal field reference.

Definition at line 85 of file mappedFlowRateFvPatchVectorField.C.

References mappedFlowRateFvPatchVectorField().

Here is the call graph for this function:

Member Function Documentation

◆ TypeName()

TypeName ( "mappedFlowRate" )

Runtime type information.

References mappedFlowRateFvPatchVectorField().

Here is the call graph for this function:

◆ clone() [1/2]

virtual tmp< fvPatchField< vector > > clone ( ) const
inlinevirtual

Return a clone.

Definition at line 180 of file mappedFlowRateFvPatchVectorField.H.

References fvPatchField< Type >::Clone().

Here is the call graph for this function:

◆ clone() [2/2]

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

Clone with an internal field reference.

Definition at line 188 of file mappedFlowRateFvPatchVectorField.H.

References fvPatchField< Type >::Clone().

Here is the call graph for this function:

◆ updateCoeffs()

void updateCoeffs ( )
virtual

Update the coefficients associated with the patch field.

Definition at line 100 of file mappedFlowRateFvPatchVectorField.C.

References DimensionedField< Type, GeoMesh >::dimensions(), Foam::dimMass, Foam::dimTime, Foam::dimVolume, mappedPatchBase::distribute(), Foam::endl(), Foam::exit(), Foam::FatalError, FatalErrorInFunction, Foam::gSum(), UPstream::incrMsgType(), patchIdentifier::index(), Foam::Info, fvPatch::lookupPatchField(), UPstream::msgType(), n, fvPatch::name(), IOobject::name(), Foam::nl, Foam::operator==(), phi, Foam::refCast(), mappedPatchBase::sampleMesh(), mappedPatchBase::samplePolyPatch(), U, and fvPatchField< Type >::updateCoeffs().

Here is the call graph for this function:

◆ write()

void write ( Ostream & os) const
virtual

Write.

Definition at line 178 of file mappedFlowRateFvPatchVectorField.C.

References os(), fvPatchField< Type >::write(), and fvPatchField< Type >::writeValueEntry().

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