Loading...
Searching...
No Matches
parPointFieldDistributor Class Reference

Distributor/redistributor for point fields, uses a two (or three) stage construction. More...

#include <parPointFieldDistributor.H>

Public Member Functions

 parPointFieldDistributor (const parPointFieldDistributor &)=delete
 No copy construct.
void operator= (const parPointFieldDistributor &)=delete
 No copy assignment.
 parPointFieldDistributor (const pointMesh &srcMesh, const bool savePoints, const bool isWriteProc)
 Basic construction.
 parPointFieldDistributor (const pointMesh &srcMesh, const bool savePoints, refPtr< fileOperation > &writeHandler)
 Basic construction.
 parPointFieldDistributor (const pointMesh &srcMesh, const pointMesh &tgtMesh, const mapDistributePolyMesh &distMap, const bool savePoints, const bool isWriteProc)
 Full construction of source/target.
 parPointFieldDistributor (const pointMesh &srcMesh, const pointMesh &tgtMesh, const mapDistributePolyMesh &distMap, const bool savePoints, refPtr< fileOperation > &writeHandler)
 Full construction of source/target.
bool hasMeshPoints () const
 True if meshPoints (per boundary) for the source mesh have been saved.
bool hasPatchPointMaps () const
 True if patch maps (per boundary) exist.
bool hasTarget () const
 True if a target mesh/distribution map has been attached.
void clearMeshPoints ()
 Clear out meshPoints (per boundary) for the source mesh.
void clearPatchPointMaps ()
 Clear out patch maps (per boundary).
void saveMeshPoints ()
 Create/recreate meshPoints (per boundary) for the source mesh.
void createPatchPointMaps ()
 Construct per-patch addressing.
void resetTarget ()
 Clear target mesh / distribution map.
void resetTarget (const pointMesh &tgtMesh, const mapDistributePolyMesh &distMap)
 Reset target mesh / distribution map.
label distributeAllFields (const IOobjectList &objects, const wordRes &selectedFields=wordRes()) const
 Read, distribute and write all/selected point field types (scalar, vector, ... types).
template<class Type>
tmp< GeometricField< Type, pointPatchField, pointMesh > > distributeField (const GeometricField< Type, pointPatchField, pointMesh > &fld) const
 Distribute point field.
template<class Type>
tmp< GeometricField< Type, pointPatchField, pointMesh > > distributePointField (const IOobject &fieldObject) const
 Read and distribute point field.
template<class Type>
label distributePointFields (const IOobjectList &objects, const wordRes &selectedFields=wordRes()) const
 Read, distribute and write all/selected point fields.
template<class Type>
void distributeAndStore (const PtrList< GeometricField< Type, pointPatchField, pointMesh > > &) const
 Distributed each (unregistered!) point field and store the result on its objectRegistry.

Static Public Attributes

static int verbose_
 Output verbosity when writing.

Detailed Description

Distributor/redistributor for point fields, uses a two (or three) stage construction.

The inconvenient multi-stage construction is needed since the pointMesh is directly associated with a polyMesh, which will probably have changed while creating the target mesh. This means that it is necessary to save the size of the source mesh and all of its patch meshPoints prior to making any changes (eg, creating the target mesh).

  1. Create with specified source mesh
  2. Save the meshPoints (per boundary) for the source mesh
  3. Attach a target mesh and mesh distribution
  4. Map the point fields

Runs in parallel. Redistributes from srcMesh to tgtMesh.

Source files

Definition at line 71 of file parPointFieldDistributor.H.

Constructor & Destructor Documentation

◆ parPointFieldDistributor() [1/5]

parPointFieldDistributor ( const parPointFieldDistributor & )
delete

No copy construct.

References parPointFieldDistributor().

Referenced by operator=(), and parPointFieldDistributor().

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

◆ parPointFieldDistributor() [2/5]

parPointFieldDistributor ( const pointMesh & srcMesh,
const bool savePoints,
const bool isWriteProc )
explicit

Basic construction.

Parameters
srcMeshThe source pointMesh
savePointsCall saveMeshPoints() immediately
isWriteProcTagged for output writing (on this proc)

◆ parPointFieldDistributor() [3/5]

parPointFieldDistributor ( const pointMesh & srcMesh,
const bool savePoints,
refPtr< fileOperation > & writeHandler )
explicit

Basic construction.

Parameters
srcMeshThe source pointMesh
savePointsCall saveMeshPoints() immediately
writeHandlerValid for output writing (on this proc)

◆ parPointFieldDistributor() [4/5]

parPointFieldDistributor ( const pointMesh & srcMesh,
const pointMesh & tgtMesh,
const mapDistributePolyMesh & distMap,
const bool savePoints,
const bool isWriteProc )
explicit

Full construction of source/target.

Parameters
srcMeshThe source pointMesh
tgtMeshThe target pointMesh
distMapThe distribution map
savePointsCall saveMeshPoints() immediately
isWriteProcTagged for output writing (on this proc)

◆ parPointFieldDistributor() [5/5]

parPointFieldDistributor ( const pointMesh & srcMesh,
const pointMesh & tgtMesh,
const mapDistributePolyMesh & distMap,
const bool savePoints,
refPtr< fileOperation > & writeHandler )
explicit

Full construction of source/target.

Parameters
srcMeshThe source pointMesh
tgtMeshThe target pointMesh
distMapThe distribution map
savePointsCall saveMeshPoints() immediately
writeHandlerValid for output writing (on this proc)

Member Function Documentation

◆ operator=()

void operator= ( const parPointFieldDistributor & )
delete

No copy assignment.

References parPointFieldDistributor().

Here is the call graph for this function:

◆ hasMeshPoints()

bool hasMeshPoints ( ) const

True if meshPoints (per boundary) for the source mesh have been saved.

◆ hasPatchPointMaps()

bool hasPatchPointMaps ( ) const

True if patch maps (per boundary) exist.

◆ hasTarget()

bool hasTarget ( ) const

True if a target mesh/distribution map has been attached.

◆ clearMeshPoints()

void clearMeshPoints ( )

Clear out meshPoints (per boundary) for the source mesh.

◆ clearPatchPointMaps()

void clearPatchPointMaps ( )

Clear out patch maps (per boundary).

◆ saveMeshPoints()

void saveMeshPoints ( )

Create/recreate meshPoints (per boundary) for the source mesh.

◆ createPatchPointMaps()

void createPatchPointMaps ( )

Construct per-patch addressing.

◆ resetTarget() [1/2]

void resetTarget ( )

Clear target mesh / distribution map.

◆ resetTarget() [2/2]

void resetTarget ( const pointMesh & tgtMesh,
const mapDistributePolyMesh & distMap )

Reset target mesh / distribution map.

◆ distributeAllFields()

label distributeAllFields ( const IOobjectList & objects,
const wordRes & selectedFields = wordRes() ) const

Read, distribute and write all/selected point field types (scalar, vector, ... types).

◆ distributeField()

template<class Type>
tmp< GeometricField< Type, pointPatchField, pointMesh > > distributeField ( const GeometricField< Type, pointPatchField, pointMesh > & fld) const

Distribute point field.

References fld().

Here is the call graph for this function:

◆ distributePointField()

template<class Type>
tmp< GeometricField< Type, pointPatchField, pointMesh > > distributePointField ( const IOobject & fieldObject) const

Read and distribute point field.

◆ distributePointFields()

template<class Type>
label distributePointFields ( const IOobjectList & objects,
const wordRes & selectedFields = wordRes() ) const

Read, distribute and write all/selected point fields.

◆ distributeAndStore()

template<class Type>
void distributeAndStore ( const PtrList< GeometricField< Type, pointPatchField, pointMesh > > & ) const

Distributed each (unregistered!) point field and store the result on its objectRegistry.

Member Data Documentation

◆ verbose_

int verbose_
static

Output verbosity when writing.

Definition at line 126 of file parPointFieldDistributor.H.

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