generatedZoneSet Class Reference
Inheritance diagram for generatedZoneSet:
Collaboration diagram for generatedZoneSet:

Public Member Functions

 generatedZoneSet ()
 Construct null. More...
 
 generatedZoneSet (const word &name, const polyMesh &mesh, const dictionary &dict)
 Construct from name, mesh and dictionary. More...
 
 generatedZoneSet (const word &name, const zoneTypes &zoneType, const polyMesh &mesh, const dictionary &dict)
 Construct from name, zoneType, mesh and dictionary. More...
 
 generatedZoneSet (const generatedZoneSet &)=delete
 Disallow default bitwise copy construction. More...
 
void read (const word &name, const polyMesh &mesh, const dictionary &dict, const bool onDemand=false)
 Read from dictionary. More...
 
void read (const word &name, const zoneTypes &zoneType, const polyMesh &mesh, const dictionary &dict, const bool onDemand=false)
 Read from dictionary. More...
 
void set (const autoPtr< zoneGenerator > &zg)
 Set the zoneGenerator and generate the zoneSet. More...
 
void generate ()
 Generate the zones and assign to the zoneSet. More...
 
bool regenerate ()
 Regenerate the zones if the regenerate switch is set true. More...
 
bool movePoints ()
 Update for mesh motion. More...
 
void distribute (const polyDistributionMap &map)
 Redistribute or update using the given distribution map. More...
 
void topoChange (const polyTopoChangeMap &map)
 Update topology using the given map. More...
 
void mapMesh (const polyMeshMap &map)
 Update from another mesh using the given map. More...
 
void operator= (const generatedZoneSet &)=delete
 Disallow default bitwise assignment. More...
 
- Public Member Functions inherited from zoneSet
 zoneSet ()
 Construct null. More...
 
 zoneSet (const zoneSet &)
 Construct copy transferring content of temporaries. More...
 
 zoneSet (zoneSet &&)=default
 Construct copy moving content. More...
 
 zoneSet (pointZone *pointZonePtr)
 Construct from pointZone pointer. More...
 
 zoneSet (cellZone *cellZonePtr)
 Construct from cellZone pointer. More...
 
 zoneSet (faceZone *faceZonePtr)
 Construct from faceZone pointer. More...
 
 zoneSet (pointZone *pointZonePtr, cellZone *cellZonePtr, faceZone *faceZonePtr)
 Construct from pointZone, cellZone and faceZone pointers. More...
 
 zoneSet (const pointZone &pointZoneRef)
 Construct from pointZone. More...
 
 zoneSet (const cellZone &cellZoneRef)
 Construct from cellZone. More...
 
 zoneSet (const faceZone &faceZoneRef)
 Construct from faceZone. More...
 
 zoneSet (const zoneSet &, bool allowTransfer)
 Construct copy transferring content of temporaries if required. More...
 
zoneSet clone (const word &name) const
 Construct and return a clone with a new name. More...
 
bool pValid () const
 Return true if the pointZone is allocated. More...
 
bool cValid () const
 Return true if the cellZone is allocated. More...
 
bool fValid () const
 Return true if the faceZone is allocated. More...
 
bool valid () const
 Return true if any of the zone types are allocated. More...
 
template<class ZoneType >
bool valid () const
 Return true if the zone type specified by template specialisation. More...
 
const pointZonepZone () const
 Return a reference to the pointZone if allocated. More...
 
const cellZonecZone () const
 Return a reference to the cellZone if allocated. More...
 
const faceZonefZone () const
 Return a reference to the faceZone if allocated. More...
 
template<class ZoneType >
const ZoneType & zone () const
 Return a reference to the zone type. More...
 
zoneSet store () const
 Store the temporary zones and return the stored zoneSet. More...
 
void operator= (const zoneSet &)
 Assignment transferring the temporary zones. More...
 
zoneSetoperator= (zoneSet &&)=default
 Assignment moving content. More...
 
void operator= (const pointZone &)
 Assignment to pointZone, updating pZone_. More...
 
void operator= (const cellZone &)
 Assignment to cellZone, updating cZone_. More...
 
void operator= (const faceZone &)
 Assignment to faceZone, updating fZone_. More...
 
template<>
bool valid () const
 
template<>
bool valid () const
 
template<>
bool valid () const
 
template<>
const pointZonezone () const
 
template<>
const cellZonezone () const
 
template<>
const faceZonezone () const
 

Detailed Description

Constructor & Destructor Documentation

◆ generatedZoneSet() [1/4]

generatedZoneSet ( )
inline

Construct null.

Definition at line 71 of file generatedZoneSet.H.

◆ generatedZoneSet() [2/4]

generatedZoneSet ( const word name,
const polyMesh mesh,
const dictionary dict 
)

Construct from name, mesh and dictionary.

Definition at line 41 of file generatedZoneSet.C.

References dict, mesh, Foam::name(), and generatedZoneSet::read().

Here is the call graph for this function:

◆ generatedZoneSet() [3/4]

generatedZoneSet ( const word name,
const zoneTypes zoneType,
const polyMesh mesh,
const dictionary dict 
)

Construct from name, zoneType, mesh and dictionary.

Definition at line 54 of file generatedZoneSet.C.

References dict, mesh, Foam::name(), generatedZoneSet::read(), and Foam::zoneType().

Here is the call graph for this function:

◆ generatedZoneSet() [4/4]

generatedZoneSet ( const generatedZoneSet )
delete

Disallow default bitwise copy construction.

Member Function Documentation

◆ read() [1/2]

void read ( const word name,
const polyMesh mesh,
const dictionary dict,
const bool  onDemand = false 
)

Read from dictionary.

Definition at line 70 of file generatedZoneSet.C.

References dictionary::add(), dict, dictionary::isDict(), IOstream::lineNumber(), dictionary::lookup(), Foam::units::lookup(), dictionary::lookupOrDefault(), mesh, Foam::name(), zoneGenerator::New(), dictionary::subDict(), and Foam::typeName().

Referenced by generatedZoneSet::generatedZoneSet().

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

◆ read() [2/2]

void read ( const word name,
const zoneTypes zoneType,
const polyMesh mesh,
const dictionary dict,
const bool  onDemand = false 
)

◆ set()

void set ( const autoPtr< zoneGenerator > &  zg)

Set the zoneGenerator and generate the zoneSet.

Definition at line 156 of file generatedZoneSet.C.

◆ generate()

void generate ( )

Generate the zones and assign to the zoneSet.

Definition at line 33 of file generatedZoneSet.C.

References zoneSet::operator=().

Here is the call graph for this function:

◆ regenerate()

bool regenerate ( )

Regenerate the zones if the regenerate switch is set true.

and return true if regenerated Useful if the zones are not purely geometric, e.g. field dependent

Definition at line 163 of file generatedZoneSet.C.

◆ movePoints()

bool movePoints ( )

Update for mesh motion.

Definition at line 174 of file generatedZoneSet.C.

◆ distribute()

void distribute ( const polyDistributionMap map)

Redistribute or update using the given distribution map.

Definition at line 185 of file generatedZoneSet.C.

◆ topoChange()

void topoChange ( const polyTopoChangeMap map)

Update topology using the given map.

Definition at line 192 of file generatedZoneSet.C.

◆ mapMesh()

void mapMesh ( const polyMeshMap map)

Update from another mesh using the given map.

Definition at line 199 of file generatedZoneSet.C.

◆ operator=()

void operator= ( const generatedZoneSet )
delete

Disallow default bitwise assignment.


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