OpenFOAM logo
The Open Source CFD Toolbox
  Source Guide OpenCFD Solutions Contact OpenFOAM

pointZone Class Reference

A subset of mesh points. The labels of points in the zone can be obtained from the addressing() list. More...

Inheritance diagram for pointZone:

Inheritance graph
[legend]
Collaboration diagram for pointZone:

Collaboration graph
[legend]

List of all members.


Public Member Functions

 TypeName ("pointZone")
 Runtime type information.
 declareRunTimeSelectionTable (autoPtr, pointZone, dictionary,(const word &name, const dictionary &dict, const label index, const pointZoneMesh &zm),(name, dict, index, zm))
 pointZone (const word &name, const labelList &addr, const label index, const pointZoneMesh &)
 Construct from components.
 pointZone (const word &name, const Xfer< labelList > &addr, const label index, const pointZoneMesh &)
 Construct from components, transferring contents.
 pointZone (const word &name, const dictionary &, const label index, const pointZoneMesh &)
 Construct from dictionary.
 pointZone (const pointZone &, const labelList &addr, const label index, const pointZoneMesh &)
 Construct given the original zone and resetting the.
 pointZone (const pointZone &, const Xfer< labelList > &addr, const label index, const pointZoneMesh &)
 Construct given the original zone, resetting the.
virtual autoPtr< pointZone > clone (const pointZoneMesh &zm) const
 Construct and return a clone, resetting the zone mesh.
virtual autoPtr< pointZone > clone (const pointZoneMesh &zm, const label index, const labelList &addr) const
 Construct and return a clone, resetting the point list.
virtual ~pointZone ()
 Destructor.
const word & name () const
 Return name.
label whichPoint (const label globalPointID) const
 Map storing the local point index for every global point.
label index () const
 Return the index of this zone in zone list.
const pointZoneMesh & zoneMesh () const
 Return zoneMesh reference.
void clearAddressing ()
 Clear addressing.
bool checkDefinition (const bool report=false) const
 Check zone definition. Return true if in error.
virtual void movePoints (const pointField &)
 Correct patch after moving points.
virtual void write (Ostream &) const
 Write.
virtual void writeDict (Ostream &) const
 Write dictionary.
void operator= (const pointZone &)
 Assign to zone clearing demand-driven data.
void operator= (const labelList &)
 Assign addressing clearing demand-driven data.

Static Public Member Functions

static autoPtr< pointZone > New (const word &name, const dictionary &, const label index, const pointZoneMesh &)
 Return a pointer to a new point zone.

Friends

Ostream & operator<< (Ostream &, const pointZone &)

Detailed Description

A subset of mesh points. The labels of points in the zone can be obtained from the addressing() list.

For quick check whether a point belongs to the zone use the lookup mechanism in pointZoneMesh, where all the zoned points are registered with their zone number.

Source files

Definition at line 62 of file pointZone.H.

Constructor & Destructor Documentation

pointZone ( const word &  name,
const labelList &  addr,
const label  index,
const pointZoneMesh &  zm 
)

Construct from components.

Definition at line 92 of file pointZone.C.

pointZone ( const word &  name,
const Xfer< labelList > &  addr,
const label  index,
const pointZoneMesh &  zm 
)

Construct from components, transferring contents.

Definition at line 108 of file pointZone.C.

pointZone ( const word &  name,
const dictionary &  dict,
const label  index,
const pointZoneMesh &  zm 
)

Construct from dictionary.

Definition at line 125 of file pointZone.C.

pointZone ( const pointZone &  pz,
const labelList &  addr,
const label  index,
const pointZoneMesh &  zm 
)

Construct given the original zone and resetting the.

point list and zone mesh information

Definition at line 143 of file pointZone.C.

pointZone ( const pointZone &  pz,
const Xfer< labelList > &  addr,
const label  index,
const pointZoneMesh &  zm 
)

Construct given the original zone, resetting the.

face list and zone mesh information

Definition at line 159 of file pointZone.C.

~pointZone (  )  [virtual]

Destructor.

Definition at line 176 of file pointZone.C.

Member Function Documentation

TypeName ( "pointZone"   ) 

Runtime type information.

declareRunTimeSelectionTable ( autoPtr  ,
pointZone  ,
dictionary  ,
(const word &name, const dictionary &dict, const label index, const pointZoneMesh &zm)  ,
(name, dict, index, zm)   
)

virtual autoPtr<pointZone> clone ( const pointZoneMesh &  zm  )  const [inline, virtual]

Construct and return a clone, resetting the zone mesh.

Definition at line 173 of file pointZone.H.

References pointZone::index().

Here is the call graph for this function:

virtual autoPtr<pointZone> clone ( const pointZoneMesh &  zm,
const label  index,
const labelList &  addr 
) const [inline, virtual]

Construct and return a clone, resetting the point list.

and zone mesh

Definition at line 186 of file pointZone.H.

Foam::autoPtr< Foam::pointZone > New ( const word &  name,
const dictionary &  dict,
const label  index,
const pointZoneMesh &  zm 
) [static]

Return a pointer to a new point zone.

created on freestore from dictionary

Definition at line 29 of file newPointZone.C.

References Foam::endl(), Foam::exit(), Foam::FatalIOError, FatalIOErrorIn, Foam::Info, and dictionary::lookup().

Here is the call graph for this function:

const word& name (  )  const [inline]

Return name.

Definition at line 222 of file pointZone.H.

Referenced by NamedEnum< Enum, nEnum >::names(), and pointZone::writeDict().

Here is the caller graph for this function:

Foam::label whichPoint ( const label  globalPointID  )  const

Map storing the local point index for every global point.

index. Used to find out the index of point in the zone from the known global point index. If the point is not in the zone, returns -1

Definition at line 184 of file pointZone.C.

References pointZone::clearAddressing().

Referenced by NamedEnum< Enum, nEnum >::names().

Here is the call graph for this function:

Here is the caller graph for this function:

label index (  )  const [inline]

Return the index of this zone in zone list.

Definition at line 236 of file pointZone.H.

Referenced by pointZone::clone().

Here is the caller graph for this function:

const Foam::pointZoneMesh & zoneMesh (  )  const

Return zoneMesh reference.

Definition at line 201 of file pointZone.C.

void clearAddressing (  ) 

Clear addressing.

Definition at line 207 of file pointZone.C.

Referenced by Foam::operator<<(), pointZone::operator=(), and pointZone::whichPoint().

Here is the caller graph for this function:

bool checkDefinition ( const bool  report = false  )  const

Check zone definition. Return true if in error.

Definition at line 213 of file pointZone.C.

References Foam::deleteDemandDrivenData().

Here is the call graph for this function:

virtual void movePoints ( const pointField &   )  [inline, virtual]

Correct patch after moving points.

Definition at line 251 of file pointZone.H.

void write ( Ostream &  os  )  const [virtual]

Write.

Definition at line 242 of file pointZone.C.

void writeDict ( Ostream &  os  )  const [virtual]

Write dictionary.

Definition at line 249 of file pointZone.C.

References pointZone::name(), and Foam::nl.

Here is the call graph for this function:

void operator= ( const pointZone &  cz  ) 

Assign to zone clearing demand-driven data.

Definition at line 262 of file pointZone.C.

Referenced by Foam::operator<<(), and pointZone::operator=().

Here is the caller graph for this function:

void operator= ( const labelList &  addr  ) 

Assign addressing clearing demand-driven data.

Definition at line 269 of file pointZone.C.

References pointZone::clearAddressing(), and pointZone::operator=().

Here is the call graph for this function:

Friends And Related Function Documentation

Ostream& operator<< ( Ostream &  ,
const pointZone &   
) [friend]

The documentation for this class was generated from the following files:
Copyright © 2000-2009 OpenCFD Ltd