Public Member Functions | List of all members
mappedFlowRateVelocityFvPatchVectorField Class Reference

This boundary condition maps the flow rate from a neighbouring patch to this patch, then uses it to set a corresponding velocity in a direction normal to the patch. More...

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

Public Member Functions

 TypeName ("mappedFlowRateVelocity")
 Runtime type information. More...
 
 mappedFlowRateVelocityFvPatchVectorField (const fvPatch &, const DimensionedField< vector, volMesh > &, const dictionary &)
 Construct from patch, internal field and dictionary. More...
 
 mappedFlowRateVelocityFvPatchVectorField (const mappedFlowRateVelocityFvPatchVectorField &, const fvPatch &, const DimensionedField< vector, volMesh > &, const fieldMapper &)
 Construct by mapping given. More...
 
 mappedFlowRateVelocityFvPatchVectorField (const mappedFlowRateVelocityFvPatchVectorField &)=delete
 Disallow copy without setting internal field reference. More...
 
 mappedFlowRateVelocityFvPatchVectorField (const mappedFlowRateVelocityFvPatchVectorField &, 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

This boundary condition maps the flow rate from a neighbouring patch to this patch, then uses it to set a corresponding velocity in a direction normal to the patch.

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

Example of the boundary condition specification: 

    <patchName>
    {
        type            mappedFlowRateVelocity;
        value           uniform (0 0 0);
    }

This boundary condition can only be applied to patches that are of mapped type.

See also
Foam::mappedPolyPatch Foam::mappedFvPatch Foam::fixedValueFvPatchVectorField
Source files

Definition at line 94 of file mappedFlowRateVelocityFvPatchVectorField.H.

Constructor & Destructor Documentation

◆ mappedFlowRateVelocityFvPatchVectorField() [1/4]

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

Construct from patch, internal field and dictionary.

Definition at line 35 of file mappedFlowRateVelocityFvPatchVectorField.C.

References dict, mappedPatchBaseBase::from::differentPatch, and mappedPatchBaseBase::validateMapForField().

Referenced by mappedFlowRateVelocityFvPatchVectorField::clone().

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

◆ mappedFlowRateVelocityFvPatchVectorField() [2/4]

mappedFlowRateVelocityFvPatchVectorField ( const mappedFlowRateVelocityFvPatchVectorField &  ptf,
const fvPatch &  p,
const DimensionedField< vector, volMesh > &  iF,
const fieldMapper &  mapper 
)

Construct by mapping given.

mappedFlowRateVelocityFvPatchVectorField onto a new patch

Definition at line 58 of file mappedFlowRateVelocityFvPatchVectorField.C.

◆ mappedFlowRateVelocityFvPatchVectorField() [3/4]

mappedFlowRateVelocityFvPatchVectorField ( const mappedFlowRateVelocityFvPatchVectorField &  )
delete

Disallow copy without setting internal field reference.

◆ mappedFlowRateVelocityFvPatchVectorField() [4/4]

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

Copy constructor setting internal field reference.

Definition at line 74 of file mappedFlowRateVelocityFvPatchVectorField.C.

Member Function Documentation

◆ TypeName()

TypeName ( "mappedFlowRateVelocity"  )

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 151 of file mappedFlowRateVelocityFvPatchVectorField.H.

References mappedFlowRateVelocityFvPatchVectorField::mappedFlowRateVelocityFvPatchVectorField().

Here is the call graph for this function:

◆ updateCoeffs()

void updateCoeffs ( )
virtual

Update the coefficients associated with the patch field.

Definition at line 90 of file mappedFlowRateVelocityFvPatchVectorField.C.

References DimensionedField< Type, GeoMesh, PrimitiveField >::dimensions(), Foam::dimMassFlux, Foam::dimVolumetricFlux, Foam::exit(), Foam::FatalError, FatalErrorInFunction, mappedFvPatchBaseBase::getMap(), fvPatch::lookupPatchField(), UPstream::msgType(), mappedFvPatchBaseBase::nbrFvPatch(), Foam::nl, Foam::operator==(), and fvPatchField< Type >::updateCoeffs().

Here is the call graph for this function:

◆ write()

void write ( Ostream &  os) const
virtual

Write.

Definition at line 152 of file mappedFlowRateVelocityFvPatchVectorField.C.

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

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