Public Member Functions | Static Public Member Functions | List of all members
mappedFvPatchBaseBase Class Reference

Base class for fv patches that provide mapping between two fv patches. More...

Inheritance diagram for mappedFvPatchBaseBase:
Inheritance graph
[legend]

Public Member Functions

 TypeName ("mappedFvPatchBaseBase")
 Runtime type information. More...
 
 mappedFvPatchBaseBase (const fvPatch &patch)
 Construct from a patch. More...
 
virtual ~mappedFvPatchBaseBase ()
 Destructor. More...
 
const fvPatch & patch () const
 Reference to the fvPatch. More...
 
const word & nbrRegionName () const
 Name of the region to map from. More...
 
const word & nbrPatchName () const
 Name of the patch to map from. More...
 
const transformer & transform () const
 The transformation between the patches. More...
 
bool haveNbr () const
 Is the neighbour available? More...
 
const fvMesh & nbrMesh () const
 Get the mesh for the region to map from. More...
 
const fvPatch & nbrFvPatch () const
 Get the patch to map from. More...
 
 FOR_ALL_FIELD_TYPES (DEFINE_MAPPED_FV_PATCH_BASE_FROM_AND_TO_NEIGHBOUR,=0)
 Map/interpolate. More...
 

Static Public Member Functions

static const mappedFvPatchBaseBase & getMap (const fvPatch &patch)
 Cast the given fvPatch to a mappedFvPatchBaseBase. Handle errors. More...
 

Detailed Description

Base class for fv patches that provide mapping between two fv patches.

Source files

Definition at line 108 of file mappedFvPatchBaseBase.H.

Constructor & Destructor Documentation

◆ mappedFvPatchBaseBase()

mappedFvPatchBaseBase ( const fvPatch &  patch)

Construct from a patch.

Definition at line 39 of file mappedFvPatchBaseBase.C.

◆ ~mappedFvPatchBaseBase()

~mappedFvPatchBaseBase ( )
virtual

Destructor.

Definition at line 48 of file mappedFvPatchBaseBase.C.

Member Function Documentation

◆ TypeName()

TypeName ( "mappedFvPatchBaseBase"  )

Runtime type information.

◆ getMap()

const Foam::mappedFvPatchBaseBase & getMap ( const fvPatch &  patch)
static

Cast the given fvPatch to a mappedFvPatchBaseBase. Handle errors.

Definition at line 54 of file mappedFvPatchBaseBase.C.

References Foam::exit(), Foam::FatalError, FatalErrorInFunction, and fvPatch::name().

Referenced by semiPermeableBaffleMassFractionFvPatchScalarField::calcPhiYp(), radiationCoupledBase::emissivity(), filmSurfaceVelocityFvPatchVectorField::updateCoeffs(), mappedFilmPressureFvPatchScalarField::updateCoeffs(), mappedFlowRateVelocityFvPatchVectorField::updateCoeffs(), mappedVelocityFluxFvPatchField::updateCoeffs(), movingMappedWallVelocityFvPatchVectorField::updateCoeffs(), coupledTemperatureFvPatchScalarField::updateCoeffs(), and thermalBaffle1DFvPatchScalarField< solidType >::updateCoeffs().

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

◆ patch()

const Foam::fvPatch & patch ( ) const
inline

Reference to the fvPatch.

Definition at line 30 of file mappedFvPatchBaseBaseI.H.

Referenced by nonConformalMappedFvPatchBase::fromNeighbour().

Here is the caller graph for this function:

◆ nbrRegionName()

const Foam::word & nbrRegionName ( ) const
inline

Name of the region to map from.

Definition at line 36 of file mappedFvPatchBaseBaseI.H.

Referenced by Foam::checkCompleteMeshOrdering(), and Foam::checkProcMeshesOrdering().

Here is the caller graph for this function:

◆ nbrPatchName()

const Foam::word & nbrPatchName ( ) const
inline

Name of the patch to map from.

Definition at line 42 of file mappedFvPatchBaseBaseI.H.

Referenced by Foam::checkCompleteMeshOrdering(), and Foam::checkProcMeshesOrdering().

Here is the caller graph for this function:

◆ transform()

const Foam::transformer & transform ( ) const
inline

The transformation between the patches.

Definition at line 48 of file mappedFvPatchBaseBaseI.H.

References transformer::transform().

Here is the call graph for this function:

◆ haveNbr()

bool haveNbr ( ) const

Is the neighbour available?

Definition at line 70 of file mappedFvPatchBaseBase.C.

References polyMesh::boundaryMesh(), objectRegistry::foundObject(), polyBoundaryMesh::mesh(), mesh, and fvMesh::time().

Referenced by fvMeshStitcher::patchCoupleds().

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

◆ nbrMesh()

const Foam::fvMesh & nbrMesh ( ) const

Get the mesh for the region to map from.

Definition at line 78 of file mappedFvPatchBaseBase.C.

References polyMesh::boundaryMesh(), objectRegistry::lookupObject(), polyBoundaryMesh::mesh(), mesh, and fvMesh::time().

Referenced by VoFFilmTransfer::correct(), radiationCoupledBase::emissivity(), VoFFilmTransfer::filmVoFTransferRate(), nonConformalMappedFvPatchBase::fromNeighbour(), filmSurfaceVelocityFvPatchVectorField::updateCoeffs(), mappedVelocityFluxFvPatchField::updateCoeffs(), movingMappedWallVelocityFvPatchVectorField::updateCoeffs(), and coupledTemperatureFvPatchScalarField::updateCoeffs().

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

◆ nbrFvPatch()

const Foam::fvPatch & nbrFvPatch ( ) const

Get the patch to map from.

Definition at line 86 of file mappedFvPatchBaseBase.C.

References fvMesh::boundary(), polyMesh::boundaryMesh(), Foam::endl(), Foam::exit(), Foam::FatalError, FatalErrorInFunction, polyBoundaryMesh::findIndex(), polyBoundaryMesh::names(), and patchi.

Referenced by semiPermeableBaffleMassFractionFvPatchScalarField::calcPhiYp(), VoFFilmTransfer::correct(), radiationCoupledBase::emissivity(), nonConformalMappedFvPatchBase::fromNeighbour(), filmSurfaceVelocityFvPatchVectorField::updateCoeffs(), mappedFilmPressureFvPatchScalarField::updateCoeffs(), mappedFlowRateVelocityFvPatchVectorField::updateCoeffs(), mappedVelocityFluxFvPatchField::updateCoeffs(), movingMappedWallVelocityFvPatchVectorField::updateCoeffs(), and coupledTemperatureFvPatchScalarField::updateCoeffs().

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

◆ FOR_ALL_FIELD_TYPES()

FOR_ALL_FIELD_TYPES ( DEFINE_MAPPED_FV_PATCH_BASE_FROM_AND_TO_NEIGHBOUR  )

Map/interpolate.

The documentation for this class was generated from the following files: