OpenFOAM logo
Open Source CFD Toolkit

topoSetSource Class Reference

Inheritance diagram for topoSetSource:

Inheritance graph
[legend]
Collaboration diagram for topoSetSource:

Collaboration graph
[legend]
List of all members.

Public Types

enum  setAction {
  CLEAR, NEW, INVERT, ADD,
  DELETE, SUBSET, LIST
}
 Enumeration defining the valid actions. More...

Public Member Functions

 TypeName ("topoSetSource")
 Runtime type information.
 declareRunTimeSelectionTable (autoPtr, topoSetSource, word,(const polyMesh &mesh, const dictionary &dict),(mesh, dict))
 declareRunTimeSelectionTable (autoPtr, topoSetSource, istream,(const polyMesh &mesh, Istream &is),(mesh, is))
 topoSetSource (const polyMesh &mesh)
 Construct from components.
autoPtr< topoSetSourceclone () const
 Clone.
virtual ~topoSetSource ()
const polyMeshmesh () const
virtual void applyToSet (const setAction action, topoSet &) const =0

Static Public Member Functions

setAction toAction (const word &actionName)
 Convert string to action.
IstreamcheckIs (Istream &is)
 Check state of stream.
const stringusage (const word &name)
autoPtr< topoSetSourceNew (const word &topoSetSourceType, const polyMesh &mesh, const dictionary &dict)
 Return a reference to the selected topoSetSource.
autoPtr< topoSetSourceNew (const word &topoSetSourceType, const polyMesh &mesh, Istream &is)
 Return a reference to the selected topoSetSource.

Protected Member Functions

void addOrDelete (topoSet &set, const label cellI, const bool) const
 Add (if bool) cellI to set or delete cellI from set.

Protected Attributes

const polyMeshmesh_

Static Protected Attributes

HashTable< string > * usageTablePtr_
 Class with constructor to add usage string to table.

Member Enumeration Documentation

enum setAction
 

Enumeration defining the valid actions.

Enumeration values:
CLEAR 
NEW 
INVERT 
ADD 
DELETE 
SUBSET 
LIST 

Definition at line 78 of file topoSetSource.H.


Constructor & Destructor Documentation

topoSetSource const polyMesh mesh  ) 
 

Construct from components.

virtual ~topoSetSource  )  [virtual]
 


Member Function Documentation

void addOrDelete topoSet set,
const label  cellI,
const   bool
const [protected]
 

Add (if bool) cellI to set or delete cellI from set.

virtual void applyToSet const setAction  action,
topoSet
const [pure virtual]
 

Istream& checkIs Istream is  )  [static]
 

Check state of stream.

autoPtr<topoSetSource> clone  )  const [inline]
 

Clone.

Definition at line 229 of file topoSetSource.H.

declareRunTimeSelectionTable autoPtr  ,
topoSetSource  ,
istream  ,
(const polyMesh &mesh, Istream &is)  ,
(mesh, is) 
 

declareRunTimeSelectionTable autoPtr  ,
topoSetSource  ,
word  ,
(const polyMesh &mesh, const dictionary &dict)  ,
(mesh, dict) 
 

const polyMesh& mesh  )  const [inline]
 

Definition at line 262 of file topoSetSource.H.

autoPtr<topoSetSource> New const word topoSetSourceType,
const polyMesh mesh,
Istream is
[static]
 

Return a reference to the selected topoSetSource.

autoPtr<topoSetSource> New const word topoSetSourceType,
const polyMesh mesh,
const dictionary dict
[static]
 

Return a reference to the selected topoSetSource.

setAction toAction const word actionName  )  [inline, static]
 

Convert string to action.

Definition at line 142 of file topoSetSource.H.

References declareRunTimeSelectionTable, and mesh.

TypeName "topoSetSource"   ) 
 

Runtime type information.

const string& usage const word name  )  [inline, static]
 

Definition at line 203 of file topoSetSource.H.


Member Data Documentation

const polyMesh& mesh_ [protected]
 

Definition at line 111 of file topoSetSource.H.

HashTable<string>* usageTablePtr_ [static, protected]
 

Class with constructor to add usage string to table.

Definition at line 92 of file topoSetSource.H.


The documentation for this class was generated from the following file:
For further information go to www.openfoam.org