mappedFvPatchBase Class Reference

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

Inheritance diagram for mappedFvPatchBase:
Collaboration diagram for mappedFvPatchBase:

Public Member Functions

 TypeName ("mappedFvPatchBase")
 Runtime type information. More...
 
 mappedFvPatchBase (const fvPatch &patch)
 Construct from a patch. More...
 
virtual ~mappedFvPatchBase ()
 Destructor. More...
 
 FOR_ALL_FIELD_TYPES (DEFINE_MAPPED_FV_PATCH_BASE_FROM_AND_TO_NEIGHBOUR,)
 Map/interpolate. More...
 
template<class Type >
Foam::tmp< Foam::Field< Type > > fromNeighbour (const Field< Type > &nbrFld) const
 
template<class Type >
Foam::tmp< Foam::Field< Type > > toNeighbour (const Field< Type > &fld) const
 
- Public Member Functions inherited from mappedFvPatchBaseBase
 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...
 

Additional Inherited Members

- Static Public Member Functions inherited from mappedFvPatchBaseBase
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 interpolative mapping between two globally conforming fv patches.

Source files

Definition at line 52 of file mappedFvPatchBase.H.

Constructor & Destructor Documentation

◆ mappedFvPatchBase()

mappedFvPatchBase ( const fvPatch &  patch)

Construct from a patch.

Definition at line 60 of file mappedFvPatchBase.C.

◆ ~mappedFvPatchBase()

~mappedFvPatchBase ( )
virtual

Destructor.

Definition at line 69 of file mappedFvPatchBase.C.

Member Function Documentation

◆ TypeName()

TypeName ( "mappedFvPatchBase"  )

Runtime type information.

◆ FOR_ALL_FIELD_TYPES()

Map/interpolate.

◆ fromNeighbour()

Foam::tmp<Foam::Field<Type> > fromNeighbour ( const Field< Type > &  nbrFld) const

Definition at line 39 of file mappedFvPatchBase.C.

References mappedPatchBase::fromNeighbour().

Here is the call graph for this function:

◆ toNeighbour()

Foam::tmp<Foam::Field<Type> > toNeighbour ( const Field< Type > &  fld) const

Definition at line 49 of file mappedFvPatchBase.C.

References fld().

Here is the call graph for this function:

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