FreeFOAM The Cross-Platform CFD Toolkit
topoSetSource Class Reference

Base class of a source for a topoSet. More...

#include <meshTools/topoSetSource.H>


Detailed Description

Base class of a source for a topoSet.

Implementer has to modify the given set (see applyToSet) according to its function and the setAction (one of add/delete/new)

Source files

Definition at line 64 of file topoSetSource.H.

+ Inheritance diagram for topoSetSource:
+ Collaboration diagram for topoSetSource:

List of all members.

Classes

class  addToUsageTable
 Class with constructor to add usage string to table. More...
class  iNew
 Class used for the read-construction of. More...

Public Types

enum  setAction {
  CLEAR, NEW, INVERT, ADD,
  DELETE, SUBSET, LIST, REMOVE
}
 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

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

static HashTable< string > * usageTablePtr_ = NULL
 A table of usage strings.

Member Enumeration Documentation

enum setAction

Enumeration defining the valid actions.

Enumerator:
CLEAR 
NEW 
INVERT 
ADD 
DELETE 
SUBSET 
LIST 
REMOVE 

Definition at line 71 of file topoSetSource.H.


Constructor & Destructor Documentation

topoSetSource ( const polyMesh mesh)

Construct from components.

Definition at line 165 of file topoSetSource.C.

~topoSetSource ( )
virtual

Definition at line 173 of file topoSetSource.C.


Member Function Documentation

void addOrDelete ( topoSet set,
const label  cellI,
const bool  add 
) const
protected

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

Definition at line 145 of file topoSetSource.C.

TypeName ( "topoSetSource"  )

Runtime type information.

static setAction toAction ( const word actionName)
inlinestatic

Convert string to action.

Definition at line 146 of file topoSetSource.H.

Foam::Istream & checkIs ( Istream is)
static

Check state of stream.

Definition at line 126 of file topoSetSource.C.

References IOstream::eof(), Foam::exit(), Foam::FatalError, FatalErrorIn, and IOstream::good().

declareRunTimeSelectionTable ( autoPtr  ,
topoSetSource  ,
word  ,
(const polyMesh &mesh, const dictionary &dict)  ,
(mesh, dict)   
)
declareRunTimeSelectionTable ( autoPtr  ,
topoSetSource  ,
istream  ,
(const polyMesh &mesh, Istream &is)  ,
(mesh, is)   
)
static const string& usage ( const word name)
inlinestatic
autoPtr<topoSetSource> clone ( ) const
inline

Clone.

Definition at line 231 of file topoSetSource.H.

References notImplemented.

autoPtr< topoSetSource > New ( const word topoSetSourceType,
const polyMesh mesh,
const dictionary dict 
)
static

Return a reference to the selected topoSetSource.

Definition at line 41 of file topoSetSource.C.

References Foam::endl(), Foam::exit(), Foam::FatalError, FatalErrorIn, and mesh.

Referenced by topoSetSource::iNew::operator()().

autoPtr< topoSetSource > New ( const word topoSetSourceType,
const polyMesh mesh,
Istream is 
)
static

Return a reference to the selected topoSetSource.

Definition at line 70 of file topoSetSource.C.

References Foam::endl(), Foam::exit(), Foam::FatalError, FatalErrorIn, and mesh.

const polyMesh& mesh ( ) const
inline

Definition at line 264 of file topoSetSource.H.

References topoSetSource::mesh_.


Member Data Documentation

Foam::HashTable< Foam::string > * usageTablePtr_ = NULL
staticprotected
const polyMesh& mesh_
protected

Definition at line 115 of file topoSetSource.H.

Referenced by topoSetSource::mesh().


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