Public Member Functions | List of all members
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:
Inheritance graph
[legend]
Collaboration diagram for mappedFlowRateFvPatchVectorField:
Collaboration graph
[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 &)=delete
 Disallow copy without setting internal field reference. More...
 
 mappedFlowRateFvPatchVectorField (const mappedFlowRateFvPatchVectorField &, 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...
 
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 94 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 36 of file mappedFlowRateFvPatchVectorField.C.

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

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

References mappedFlowRateFvPatchVectorField::mappedFlowRateFvPatchVectorField().

Here is the call graph for this function:

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

References mappedFlowRateFvPatchVectorField::mappedFlowRateFvPatchVectorField().

Here is the call graph for this function:

◆ mappedFlowRateFvPatchVectorField() [4/5]

mappedFlowRateFvPatchVectorField ( const mappedFlowRateFvPatchVectorField &  )
delete

Disallow copy without setting internal field reference.

◆ mappedFlowRateFvPatchVectorField() [5/5]

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

Copy constructor setting internal field reference.

Definition at line 78 of file mappedFlowRateFvPatchVectorField.C.

Member Function Documentation

◆ TypeName()

TypeName ( "mappedFlowRate"  )

Runtime type information.

◆ clone()

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

Construct and return a clone setting internal field reference.

Definition at line 159 of file mappedFlowRateFvPatchVectorField.H.

References mappedFlowRateFvPatchVectorField::mappedFlowRateFvPatchVectorField(), mappedFlowRateFvPatchVectorField::updateCoeffs(), and mappedFlowRateFvPatchVectorField::write().

Here is the call graph for this function:

◆ updateCoeffs()

void updateCoeffs ( )
virtual

Update the coefficients associated with the patch field.

Definition at line 92 of file mappedFlowRateFvPatchVectorField.C.

References boundary(), DimensionedField< Type, GeoMesh >::dimensions(), Foam::dimFlux, Foam::dimMassFlux, mappedPatchBase::distribute(), Foam::endl(), Foam::exit(), Foam::FatalError, FatalErrorInFunction, Foam::gSum(), patchIdentifier::index(), Foam::Info, fvPatch::lookupPatchField(), UPstream::msgType(), n, fvPatch::name(), Foam::nl, Foam::operator==(), phi, mappedPatchBase::sampleMesh(), mappedPatchBase::samplePolyPatch(), U, fvPatchField< Type >::updateCoeffs(), and mappedFlowRateFvPatchVectorField::write().

Referenced by mappedFlowRateFvPatchVectorField::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 172 of file mappedFlowRateFvPatchVectorField.C.

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

Referenced by mappedFlowRateFvPatchVectorField::clone(), and mappedFlowRateFvPatchVectorField::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: