Public Member Functions | List of all members
mappedVelocityFluxFixedValueFvPatchField Class Reference
Boundary conditions » InletBoundary conditions » | Coupled

This boundary condition maps the velocity and flux from a neighbour patch to this patch. More...

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

Public Member Functions

 TypeName ("mappedVelocityFlux")
 Runtime type information. More...
 
 mappedVelocityFluxFixedValueFvPatchField (const fvPatch &, const DimensionedField< vector, volMesh > &)
 Construct from patch and internal field. More...
 
 mappedVelocityFluxFixedValueFvPatchField (const fvPatch &, const DimensionedField< vector, volMesh > &, const dictionary &)
 Construct from patch, internal field and dictionary. More...
 
 mappedVelocityFluxFixedValueFvPatchField (const mappedVelocityFluxFixedValueFvPatchField &, const fvPatch &, const DimensionedField< vector, volMesh > &, const fvPatchFieldMapper &)
 Construct by mapping given. More...
 
 mappedVelocityFluxFixedValueFvPatchField (const mappedVelocityFluxFixedValueFvPatchField &)
 Construct as copy. More...
 
virtual tmp< fvPatchVectorField > clone () const
 Construct and return a clone. More...
 
 mappedVelocityFluxFixedValueFvPatchField (const mappedVelocityFluxFixedValueFvPatchField &, const DimensionedField< vector, volMesh > &)
 Construct as copy 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 velocity and flux from a neighbour patch to this patch.

Usage
Property Description Required Default value
phi flux field name no phi

Example of the boundary condition specification: 

    <patchName>
    {
        type            mappedVelocityFlux;
        phi             phi;
        value           uniform 0;  // place holder
    }

The underlying sample mode should be set to nearestPatchFace or nearestFace

Note
This boundary condition can only be applied to patches that are of the mappedPolyPatch type.
See also
Foam::mappedPatchBase Foam::mappedPolyPatch Foam::mappedFvPatch Foam::fixedValueFvPatchVectorField
Source files

Definition at line 90 of file mappedVelocityFluxFixedValueFvPatchField.H.

Constructor & Destructor Documentation

◆ mappedVelocityFluxFixedValueFvPatchField() [1/5]

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

Construct from patch and internal field.

Definition at line 34 of file mappedVelocityFluxFixedValueFvPatchField.C.

Referenced by mappedVelocityFluxFixedValueFvPatchField::clone().

Here is the caller graph for this function:

◆ mappedVelocityFluxFixedValueFvPatchField() [2/5]

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

Construct from patch, internal field and dictionary.

Definition at line 71 of file mappedVelocityFluxFixedValueFvPatchField.C.

References dict, Foam::exit(), Foam::FatalError, FatalErrorInFunction, mappedPatchBase::mode(), p, and Foam::foamVersion::patch.

Here is the call graph for this function:

◆ mappedVelocityFluxFixedValueFvPatchField() [3/5]

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

Construct by mapping given.

mappedVelocityFluxFixedValueFvPatchField onto a new patch

Definition at line 46 of file mappedVelocityFluxFixedValueFvPatchField.C.

References Foam::exit(), Foam::FatalError, FatalErrorInFunction, p, and Foam::foamVersion::patch.

Here is the call graph for this function:

◆ mappedVelocityFluxFixedValueFvPatchField() [4/5]

mappedVelocityFluxFixedValueFvPatchField ( const mappedVelocityFluxFixedValueFvPatchField &  ptf)

Construct as copy.

Definition at line 111 of file mappedVelocityFluxFixedValueFvPatchField.C.

◆ mappedVelocityFluxFixedValueFvPatchField() [5/5]

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

Construct as copy setting internal field reference.

Definition at line 122 of file mappedVelocityFluxFixedValueFvPatchField.C.

Member Function Documentation

◆ TypeName()

TypeName ( "mappedVelocityFlux"  )

Runtime type information.

◆ clone() [1/2]

virtual tmp<fvPatchVectorField> clone ( ) const
inlinevirtual

Construct and return a clone.

Definition at line 155 of file mappedVelocityFluxFixedValueFvPatchField.H.

References mappedVelocityFluxFixedValueFvPatchField::mappedVelocityFluxFixedValueFvPatchField().

Here is the call graph for this function:

◆ 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 176 of file mappedVelocityFluxFixedValueFvPatchField.H.

References mappedVelocityFluxFixedValueFvPatchField::mappedVelocityFluxFixedValueFvPatchField().

Here is the call graph for this function:

◆ updateCoeffs()

void updateCoeffs ( )
virtual

Update the coefficients associated with the patch field.

Definition at line 134 of file mappedVelocityFluxFixedValueFvPatchField.C.

References Foam::abort(), GeometricField< Type, PatchField, GeoMesh >::boundaryField(), boundaryFieldRef(), mappedPatchBase::distribute(), Foam::FatalError, FatalErrorInFunction, forAll, UPstream::incrMsgType(), mappedPatchBase::mode(), UPstream::msgType(), mappedPatchBase::NEARESTFACE, mappedPatchBase::NEARESTPATCHFACE, mappedPatchBase::NEARESTPATCHFACEAMI, Foam::nl, Foam::operator==(), Foam::foamVersion::patch, fvPatchFieldBase::patch(), mappedPatchBase::sampleMesh(), mappedPatchBase::samplePatch(), fvPatch::start(), List< T >::transfer(), and Foam::Zero.

Here is the call graph for this function:

◆ write()

void write ( Ostream &  os) const
virtual

Write.

Definition at line 226 of file mappedVelocityFluxFixedValueFvPatchField.C.

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

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