fieldToCell Class Reference

A topoSetSource to select cells based on field values. More...

Inheritance diagram for fieldToCell:

Collaboration diagram for fieldToCell:

Public Member Functions
	TypeName ("fieldToCell")
	Runtime type information. More...
	fieldToCell (const polyMesh &mesh, const word &fieldName, const scalar min, const scalar max)
	Construct from components. More...
	fieldToCell (const polyMesh &mesh, const dictionary &dict)
	Construct from dictionary. More...
	fieldToCell (const polyMesh &mesh, Istream &)
	Construct from Istream. More...
virtual	~fieldToCell ()
	Destructor. More...
virtual sourceType	setType () const
virtual void	applyToSet (const topoSetSource::setAction action, topoSet &) const
Public Member Functions inherited from topoSetSource
	TypeName ("topoSetSource")
	Runtime type information. More...
	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. More...
autoPtr< topoSetSource >	clone () const
	Clone. More...
virtual	~topoSetSource ()
	Destructor. More...
const polyMesh &	mesh () const

Private Member Functions
void	applyToSet (const topoSetSource::setAction action, const scalarField &field, topoSet &set) const
	Depending on field values add to or delete from cellSet. More...

Private Attributes
word	fieldName_
	Name of volScalarField. More...
scalar	min_
	Min to subset field values with. More...
scalar	max_
	Max ,,. More...

Static Private Attributes
static addToUsageTable	usage_
	Add usage string. More...

Additional Inherited Members
Public Types inherited from topoSetSource
enum	sourceType {   CELLSETSOURCE, FACESETSOURCE, POINTSETSOURCE, CELLZONESOURCE,   FACEZONESOURCE, POINTZONESOURCE }
	Enumeration defining the types of sources. More...
enum	setAction {   CLEAR, NEW, INVERT, ADD,   DELETE, SUBSET, LIST, REMOVE }
	Enumeration defining the valid actions. More...
Static Public Member Functions inherited from topoSetSource
static setAction	toAction (const word &actionName)
	Convert string to action. More...
static Istream &	checkIs (Istream &is)
	Check state of stream. More...
static const string &	usage (const word &name)
static autoPtr< topoSetSource >	New (const word &topoSetSourceType, const polyMesh &mesh, const dictionary &dict)
	Return a reference to the selected topoSetSource. More...
static autoPtr< topoSetSource >	New (const word &topoSetSourceType, const polyMesh &mesh, Istream &is)
	Return a reference to the selected topoSetSource. More...
Protected Member Functions inherited from topoSetSource
void	addOrDelete (topoSet &set, const label cellI, const bool) const
	Add (if bool) cellI to set or delete cellI from set. More...
Protected Attributes inherited from topoSetSource
const polyMesh &	mesh_
Static Protected Attributes inherited from topoSetSource
static HashTable< string > *	usageTablePtr_ = NULL
	A table of usage strings. More...

Detailed Description

A topoSetSource to select cells based on field values.

Source files

• fieldToCell.H
• fieldToCell.C

Definition at line 49 of file fieldToCell.H.

Constructor & Destructor Documentation

fieldToCell() [1/3]

fieldToCell	(	const polyMesh &	mesh,
		const word &	fieldName,
		const scalar	min,
		const scalar	max
	)

Construct from components.

Definition at line 102 of file fieldToCell.C.

fieldToCell() [2/3]

fieldToCell	(	const polyMesh &	mesh,
		const dictionary &	dict
	)

Construct from dictionary.

Definition at line 118 of file fieldToCell.C.

fieldToCell() [3/3]

fieldToCell	(	const polyMesh &	mesh,
		Istream &	is
	)

Construct from Istream.

Definition at line 132 of file fieldToCell.C.

~fieldToCell()

~fieldToCell ( )

virtual

Destructor.

Definition at line 146 of file fieldToCell.C.

Member Function Documentation

applyToSet() [1/2]

void applyToSet ( const topoSetSource::setAction  action, const scalarField &  field, topoSet &  set  ) const

private

Depending on field values add to or delete from cellSet.

Definition at line 60 of file fieldToCell.C.

References Foam::endl(), HashTable::erase(), forAll, Foam::Info, HashSet< Key, Hash >::insert(), Foam::max(), and Foam::min().

Here is the call graph for this function:

TypeName()

TypeName

(

"fieldToCell"

)

Runtime type information.

setType()

virtual sourceType setType ( ) const

inlinevirtual

Implements topoSetSource.

Definition at line 117 of file fieldToCell.H.

References topoSetSource::CELLSETSOURCE.

applyToSet() [2/2]

void applyToSet ( const topoSetSource::setAction  action, topoSet &  set  ) const

virtual

Implements topoSetSource.

Definition at line 153 of file fieldToCell.C.

References IOobject::AUTO_WRITE, Foam::endl(), fieldObject(), IOobject::filePath(), IOobject::headerClassName(), IOobject::headerOk(), Foam::mag(), mesh, IOobject::MUST_READ, fvMesh::time(), timeName, Time::timeName(), and WarningInFunction.

Here is the call graph for this function:

Field Documentation

usage_

Foam::topoSetSource::addToUsageTable usage_

staticprivate

Add usage string.

Definition at line 57 of file fieldToCell.H.

fieldName_

word fieldName_

private

Name of volScalarField.

Definition at line 61 of file fieldToCell.H.

min_

scalar min_

private

Min to subset field values with.

Definition at line 64 of file fieldToCell.H.

max_

scalar max_

private

Max ,,.

Definition at line 67 of file fieldToCell.H.

---

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

• src/meshTools/sets/cellSources/fieldToCell/fieldToCell.H
• src/meshTools/sets/cellSources/fieldToCell/fieldToCell.C