FreeFOAM programmer's C++ documentation

All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages

Determines a mapping between patch face centres and mesh cell or face centres and processors they're on. More...

#include <meshTools/directMappedPatchBase.H>

Detailed Description

Determines a mapping between patch face centres and mesh cell or face centres and processors they're on.

Note:: Storage is not optimal. It temporary collects all (patch)face centres on all processors to keep the addressing calculation simple.

Source files

Definition at line 60 of file directMappedPatchBase.H.

Inheritance diagram for directMappedPatchBase:

List of all members.

Classes
class	nearestEqOp

Public Types
enum	sampleMode { NEARESTCELL, NEARESTPATCHFACE, NEARESTFACE }
	Mesh items to sample. More...
typedef Tuple2< pointIndexHit, Tuple2< scalar, label > >	nearInfo
	Helper class for finding nearest.

Public Member Functions
	TypeName ("directMappedPatchBase")
	Runtime type information.
	directMappedPatchBase (const polyPatch &)
	Construct from patch.
	directMappedPatchBase (const polyPatch &pp, const word &sampleRegion, const sampleMode sampleMode, const word &samplePatch, const vectorField &offset)
	Construct from components.
	directMappedPatchBase (const polyPatch &pp, const word &sampleRegion, const sampleMode sampleMode, const word &samplePatch, const vector &offset)
	Construct from components.
	directMappedPatchBase (const polyPatch &, const dictionary &)
	Construct from dictionary.
	directMappedPatchBase (const polyPatch &, const directMappedPatchBase &)
	Construct as copy, resetting patch.
virtual	~directMappedPatchBase ()
	Destructor.
void	clearOut ()
const sampleMode &	mode () const
	What to sample.
const word &	sampleRegion () const
	Region to sample.
const word &	samplePatch () const
	Patch (only if NEARESTPATCHFACE)
const vectorField &	offsets () const
	Offset vector (from patch faces to destination mesh objects)
const mapDistribute &	map () const
	Return reference to the parallel distribution map.
bool	sameRegion () const
	Cached sampleRegion != mesh.name()
const polyMesh &	sampleMesh () const
	Get the region mesh.
const polyPatch &	samplePolyPatch () const
	Get the patch on the region.
virtual void	write (Ostream &) const
	Write as a dictionary.

Member Typedef Documentation

typedef Tuple2<pointIndexHit, Tuple2<scalar, label> > nearInfo

Helper class for finding nearest.

point+local index

sqr(distance)

processor

Definition at line 78 of file directMappedPatchBase.H.

Member Enumeration Documentation

enum sampleMode

Mesh items to sample.

Enumerator:

NEARESTCELL
NEARESTPATCHFACE
NEARESTFACE

Definition at line 66 of file directMappedPatchBase.H.

Constructor & Destructor Documentation

directMappedPatchBase ( const polyPatch & pp )

Construct from patch.

Definition at line 562 of file directMappedPatchBase.C.

directMappedPatchBase	(	const polyPatch &	pp,
		const word &	sampleRegion,
		const sampleMode	sampleMode,
		const word &	samplePatch,
		const vectorField &	offset
	)

Construct from components.

Definition at line 579 of file directMappedPatchBase.C.

directMappedPatchBase	(	const polyPatch &	pp,
		const word &	sampleRegion,
		const sampleMode	sampleMode,
		const word &	samplePatch,
		const vector &	offset
	)

Construct from components.

Definition at line 599 of file directMappedPatchBase.C.

directMappedPatchBase	(	const polyPatch &	pp,
		const dictionary &	dict
	)

Construct from dictionary.

Definition at line 620 of file directMappedPatchBase.C.

directMappedPatchBase	(	const polyPatch &	pp,
		const directMappedPatchBase &	dmp
	)

Construct as copy, resetting patch.

Definition at line 655 of file directMappedPatchBase.C.

~directMappedPatchBase ( )

virtual

Destructor.

Definition at line 674 of file directMappedPatchBase.C.

Member Function Documentation

TypeName ( "directMappedPatchBase" )

Runtime type information.

void clearOut ( )

Definition at line 680 of file directMappedPatchBase.C.

Referenced by directMappedPolyPatch::calcGeometry(), directMappedWallPolyPatch::calcGeometry(), directMappedWallPolyPatch::initGeometry(), directMappedPolyPatch::initGeometry(), directMappedPolyPatch::initMovePoints(), directMappedWallPolyPatch::initMovePoints(), directMappedWallPolyPatch::initUpdateMesh(), directMappedPolyPatch::initUpdateMesh(), directMappedPolyPatch::movePoints(), directMappedWallPolyPatch::movePoints(), directMappedPolyPatch::updateMesh(), directMappedWallPolyPatch::updateMesh(), directMappedPolyPatch::~directMappedPolyPatch(), and directMappedWallPolyPatch::~directMappedWallPolyPatch().

const sampleMode& mode ( ) const

inline

What to sample.

Definition at line 212 of file directMappedPatchBase.H.

Referenced by directMappedVelocityFluxFixedValueFvPatchField::updateCoeffs(), and directMappedFixedValueFvPatchField< Type >::updateCoeffs().

const word& sampleRegion ( ) const

inline

Region to sample.

Definition at line 218 of file directMappedPatchBase.H.

Referenced by directMappedFixedValueFvPatchField< Type >::updateCoeffs().

const word& samplePatch ( ) const

inline

Patch (only if NEARESTPATCHFACE)

Definition at line 224 of file directMappedPatchBase.H.

Referenced by directMappedVelocityFluxFixedValueFvPatchField::updateCoeffs(), and directMappedFixedValueFvPatchField< Type >::updateCoeffs().

const vectorField& offsets ( ) const

inline

Offset vector (from patch faces to destination mesh objects)

Definition at line 230 of file directMappedPatchBase.H.

const mapDistribute& map ( ) const

inline

Return reference to the parallel distribution map.

Definition at line 236 of file directMappedPatchBase.H.

References autoPtr< T >::empty().

Referenced by directMappedVelocityFluxFixedValueFvPatchField::updateCoeffs(), directMappedFixedValueFvPatchField< Type >::updateCoeffs(), turbulentTemperatureCoupledBaffleMixedFvPatchScalarField::updateCoeffs(), and turbulentTemperatureCoupledBaffleFvPatchScalarField::updateCoeffs().

bool sameRegion ( ) const

inline

Cached sampleRegion != mesh.name()

Definition at line 246 of file directMappedPatchBase.H.

Referenced by directMappedFixedValueFvPatchField< Type >::updateCoeffs().

const Foam::polyMesh & sampleMesh ( ) const

Get the region mesh.

Definition at line 688 of file directMappedPatchBase.C.

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

Referenced by directMappedVelocityFluxFixedValueFvPatchField::updateCoeffs(), directMappedFixedValueFvPatchField< Type >::updateCoeffs(), turbulentTemperatureCoupledBaffleMixedFvPatchScalarField::updateCoeffs(), and turbulentTemperatureCoupledBaffleFvPatchScalarField::updateCoeffs().

const Foam::polyPatch & samplePolyPatch ( ) const

Get the patch on the region.

Definition at line 697 of file directMappedPatchBase.C.

References polyMesh::boundaryMesh(), Foam::exit(), Foam::FatalError, FatalErrorIn, polyBoundaryMesh::findPatchID(), and polyBoundaryMesh::names().

Referenced by turbulentTemperatureCoupledBaffleMixedFvPatchScalarField::updateCoeffs(), and turbulentTemperatureCoupledBaffleFvPatchScalarField::updateCoeffs().

void write ( Ostream & os ) const

virtual

Write as a dictionary.

Reimplemented in directMappedWallPolyPatch, and directMappedPolyPatch.

Definition at line 716 of file directMappedPatchBase.C.

References token::END_STATEMENT, Foam::nl, and Ostream::writeKeyword().

Referenced by directMappedPolyPatch::write(), and directMappedWallPolyPatch::write().

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

src/meshTools/directMapped/directMappedPolyPatch/directMappedPatchBase.H
src/meshTools/directMapped/directMappedPolyPatch/directMappedPatchBase.C