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

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

#include <mappedVelocityFluxFixedValueFvPatchField.H>

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

Public Member Functions

 TypeName ("mappedVelocityFlux")
 Runtime type information.
 mappedVelocityFluxFixedValueFvPatchField (const fvPatch &, const DimensionedField< vector, volMesh > &)
 Construct from patch and internal field.
 mappedVelocityFluxFixedValueFvPatchField (const fvPatch &, const DimensionedField< vector, volMesh > &, const dictionary &)
 Construct from patch, internal field and dictionary.
 mappedVelocityFluxFixedValueFvPatchField (const mappedVelocityFluxFixedValueFvPatchField &, const fvPatch &, const DimensionedField< vector, volMesh > &, const fvPatchFieldMapper &)
 Construct by mapping given.
 mappedVelocityFluxFixedValueFvPatchField (const mappedVelocityFluxFixedValueFvPatchField &)
 Construct as copy.
 mappedVelocityFluxFixedValueFvPatchField (const mappedVelocityFluxFixedValueFvPatchField &, 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

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 32 of file mappedVelocityFluxFixedValueFvPatchField.C.

References p.

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

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 69 of file mappedVelocityFluxFixedValueFvPatchField.C.

References dict, Foam::exit(), Foam::FatalError, FatalErrorInFunction, Foam::isA(), mappedPatchBase::mode(), mappedPatchBase::NEARESTCELL, p, and Foam::refCast().

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 44 of file mappedVelocityFluxFixedValueFvPatchField.C.

References Foam::exit(), Foam::FatalError, FatalErrorInFunction, Foam::isA(), mappedVelocityFluxFixedValueFvPatchField(), and p.

Here is the call graph for this function:

◆ mappedVelocityFluxFixedValueFvPatchField() [4/5]

mappedVelocityFluxFixedValueFvPatchField ( const mappedVelocityFluxFixedValueFvPatchField & ptf)

Construct as copy.

Definition at line 109 of file mappedVelocityFluxFixedValueFvPatchField.C.

References mappedVelocityFluxFixedValueFvPatchField().

Here is the call graph for this function:

◆ mappedVelocityFluxFixedValueFvPatchField() [5/5]

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

Construct as copy setting internal field reference.

Definition at line 120 of file mappedVelocityFluxFixedValueFvPatchField.C.

References mappedVelocityFluxFixedValueFvPatchField().

Here is the call graph for this function:

Member Function Documentation

◆ TypeName()

TypeName ( "mappedVelocityFlux" )

Runtime type information.

References mappedVelocityFluxFixedValueFvPatchField().

Here is the call graph for this function:

◆ clone() [1/2]

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

Return a clone.

Definition at line 164 of file mappedVelocityFluxFixedValueFvPatchField.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 172 of file mappedVelocityFluxFixedValueFvPatchField.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 134 of file mappedVelocityFluxFixedValueFvPatchField.C.

References Foam::abort(), GeometricField< Type, PatchField, GeoMesh >::boundaryField(), polyMesh::boundaryMesh(), mappedPatchBase::distribute(), Foam::FatalError, FatalErrorInFunction, polyBoundaryMesh::findPatchID(), forAll, UPstream::incrMsgType(), objectRegistry::lookupObject(), mappedPatchBase::mode(), UPstream::msgType(), mappedPatchBase::NEARESTFACE, mappedPatchBase::NEARESTPATCHFACE, mappedPatchBase::NEARESTPATCHFACEAMI, primitiveMesh::nFaces(), Foam::nl, Foam::operator==(), fvPatchFieldBase::patch(), Foam::refCast(), 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 222 of file mappedVelocityFluxFixedValueFvPatchField.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: