timeActivatedExplicitSource Class Reference

Base class for field sources. Provides:

• name
• references to mesh and time
• dimensions
• volume type
• startTime
• duration
• read (from <sourceName>Properties dictionary).

More...

Inheritance diagram for timeActivatedExplicitSource:

[legend]

Collaboration diagram for timeActivatedExplicitSource:

[legend]

List of all members.

Public Types
enum	volumeType { vtSpecific, vtAbsolute }
Public Member Functions
	timeActivatedExplicitSource (const word &, const fvMesh &, const dimensionSet &)
	Construct from explicit source name and mesh.
virtual const fvMesh &	mesh () const
	Return the reference to the mesh.
virtual const Time &	runTime () const
	Return the reference to the time database.
virtual const word &	name () const
	Return the source name.
virtual const Switch &	active () const
	Return the active flag.
virtual const dimensionSet &	dimensions () const
	Return the dimensions.
virtual const volumeType &	volume () const
	Return the volume type.
virtual scalar	timeStart () const
	Return the start time.
virtual scalar	duration () const
	Return the duration.
virtual bool	read ()
	Read properties dictionary.
Static Public Attributes
static const NamedEnum < volumeType, 2 >	volumeTypeNames_
Protected Attributes
const fvMesh &	mesh_
	Reference to the mesh.
const Time &	runTime_
	Reference to time database.
word	name_
	Name of the source.
Switch	active_
	Active flag.
const dimensionSet	dimensions_
	Dimensions.
volumeType	volumeType_
	Volume type.
scalar	timeStart_
	Time start [s].
scalar	duration_
	Duration [s].

---

Detailed Description

Base class for field sources. Provides:

• name
• references to mesh and time
• dimensions
• volume type
• startTime
• duration
• read (from <sourceName>Properties dictionary).

Source files

• timeActivatedExplicitSource.H
• timeActivatedExplicitSource.C

Definition at line 55 of file timeActivatedExplicitSource.H.

---

Member Enumeration Documentation

enum volumeType

Enumerator:

vtSpecific
vtAbsolute

Definition at line 61 of file timeActivatedExplicitSource.H.

---

Constructor & Destructor Documentation

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

Construct from explicit source name and mesh.

Definition at line 41 of file timeActivatedExplicitSource.C.

---

Member Function Documentation

const Foam::fvMesh & mesh

(

)

const [virtual]

Return the reference to the mesh.

Definition at line 71 of file timeActivatedExplicitSource.C.

const Foam::Time & runTime

(

)

const [virtual]

Return the reference to the time database.

Definition at line 77 of file timeActivatedExplicitSource.C.

References timeActivatedExplicitSource::mesh_.

const Foam::word & name

(

)

const [virtual]

Return the source name.

Reimplemented from IOdictionary.

Definition at line 83 of file timeActivatedExplicitSource.C.

const Foam::Switch & active

(

)

const [virtual]

Return the active flag.

Definition at line 89 of file timeActivatedExplicitSource.C.

const Foam::dimensionSet & dimensions

(

)

const [virtual]

Return the dimensions.

Definition at line 95 of file timeActivatedExplicitSource.C.

const Foam::timeActivatedExplicitSource::volumeType & volume

(

)

const [virtual]

Return the volume type.

Definition at line 102 of file timeActivatedExplicitSource.C.

References timeActivatedExplicitSource::dimensions_.

Foam::scalar timeStart

(

)

const [virtual]

Return the start time.

Definition at line 108 of file timeActivatedExplicitSource.C.

References timeActivatedExplicitSource::volumeType_.

Foam::scalar duration

(

)

const [virtual]

Return the duration.

Definition at line 114 of file timeActivatedExplicitSource.C.

bool read

(

)

[virtual]

Read properties dictionary.

Reimplemented from regIOobject.

Reimplemented in timeActivatedExplicitCellSource.

Definition at line 120 of file timeActivatedExplicitSource.C.

---

Member Data Documentation

const Foam::NamedEnum< Foam::timeActivatedExplicitSource::volumeType, 2 > volumeTypeNames_ [static]

Definition at line 67 of file timeActivatedExplicitSource.H.

const fvMesh& mesh_ [protected]

Reference to the mesh.

Definition at line 86 of file timeActivatedExplicitSource.H.

Referenced by timeActivatedExplicitSource::runTime().

const Time& runTime_ [protected]

Reference to time database.

Definition at line 89 of file timeActivatedExplicitSource.H.

word name_ [protected]

Name of the source.

Reimplemented from dictionary.

Definition at line 95 of file timeActivatedExplicitSource.H.

Switch active_ [protected]

Active flag.

Definition at line 98 of file timeActivatedExplicitSource.H.

const dimensionSet dimensions_ [protected]

Dimensions.

Definition at line 101 of file timeActivatedExplicitSource.H.

Referenced by timeActivatedExplicitSource::volume().

volumeType volumeType_ [protected]

Volume type.

Definition at line 104 of file timeActivatedExplicitSource.H.

Referenced by timeActivatedExplicitSource::timeStart().

scalar timeStart_ [protected]

Time start [s].

Definition at line 107 of file timeActivatedExplicitSource.H.

scalar duration_ [protected]

Duration [s].

Definition at line 110 of file timeActivatedExplicitSource.H.

---

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

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