timeActivatedExplicitCellSource Class Reference

Inheritance diagram for timeActivatedExplicitCellSource:

[legend]

Collaboration diagram for timeActivatedExplicitCellSource:

[legend]

List of all members.

Public Member Functions
	timeActivatedExplicitCellSource (const word &, const fvMesh &, const dimensionSet &)
	Construct from explicit source name and mesh.
virtual scalar	onValue () const
	Return the "on" value.
virtual scalar	offValue () const
	Return the "off" value.
virtual tmp< DimensionedField < scalar, volMesh > >	Su ()
	Return a tmp field of the source.
virtual bool	read ()
	Read properties dictionary.
Protected Attributes
scalar	onValue_
	Value when "on".
scalar	offValue_
	Value when "off".
scalarList	V_
	Cell volumes.
word	cellSource_
	Name of cell source (XXXToCell).
autoPtr< topoSetSource >	cellSelector_
	Method by which the cells will be selected.
cellSet	selectedCellSet_
	Set of selected cells.

---

Detailed Description

Definition at line 48 of file timeActivatedExplicitCellSource.H.

---

Constructor & Destructor Documentation

timeActivatedExplicitCellSource	(	const word &	name,
		const fvMesh &	mesh,
		const dimensionSet &	dims
	)

Construct from explicit source name and mesh.

Definition at line 46 of file timeActivatedExplicitCellSource.C.

---

Member Function Documentation

Foam::scalar onValue

(

)

const [virtual]

Return the "on" value.

Definition at line 80 of file timeActivatedExplicitCellSource.C.

Foam::scalar offValue

(

)

const [virtual]

Return the "off" value.

Definition at line 86 of file timeActivatedExplicitCellSource.C.

References timeActivatedExplicitCellSource::onValue_.

Foam::tmp< Foam::DimensionedField< Foam::scalar, Foam::volMesh > > Su

(

)

[virtual]

Return a tmp field of the source.

Definition at line 93 of file timeActivatedExplicitCellSource.C.

References timeActivatedExplicitCellSource::offValue_.

bool read

(

)

[virtual]

Read properties dictionary.

Reimplemented from timeActivatedExplicitSource.

Definition at line 141 of file timeActivatedExplicitCellSource.C.

References timeActivatedExplicitCellSource::V_.

---

Member Data Documentation

scalar onValue_ [protected]

Value when "on".

Definition at line 76 of file timeActivatedExplicitCellSource.H.

Referenced by timeActivatedExplicitCellSource::offValue().

scalar offValue_ [protected]

Value when "off".

Definition at line 79 of file timeActivatedExplicitCellSource.H.

Referenced by timeActivatedExplicitCellSource::Su().

scalarList V_ [protected]

Cell volumes.

Definition at line 85 of file timeActivatedExplicitCellSource.H.

Referenced by timeActivatedExplicitCellSource::read().

word cellSource_ [protected]

Name of cell source (XXXToCell).

Definition at line 88 of file timeActivatedExplicitCellSource.H.

autoPtr<topoSetSource> cellSelector_ [protected]

Method by which the cells will be selected.

Definition at line 91 of file timeActivatedExplicitCellSource.H.

cellSet selectedCellSet_ [protected]

Set of selected cells.

Definition at line 94 of file timeActivatedExplicitCellSource.H.

---

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

• src/finiteVolume/cfdTools/general/fieldSources/timeActivatedExplicitCellSource/timeActivatedExplicitCellSource.H
• src/finiteVolume/cfdTools/general/fieldSources/timeActivatedExplicitCellSource/timeActivatedExplicitCellSource.C