FreeFOAM The Cross-Platform CFD Toolkit
Hosted by SourceForge:
Get FreeFOAM at SourceForge.net.
            Fast, secure and Free Open Source software downloads

directMappedPatchBase Class Reference

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:
Collaboration 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.

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]
const vectorField& offsets (  ) const [inline]

Offset vector (from patch faces to destination mesh objects)

Definition at line 230 of file directMappedPatchBase.H.

bool sameRegion (  ) const [inline]

Cached sampleRegion != mesh.name()

Definition at line 246 of file directMappedPatchBase.H.

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

void write ( Ostream &   os  ) const [virtual]

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