outputFilterOutputControl Class Reference

An output control for function objects. The default is time-step execution at every interval. More...

Collaboration diagram for outputFilterOutputControl:

Public Types
enum	outputControls {   ocTimeStep, ocOutputTime, ocAdjustableTime, ocRunTime,   ocClockTime, ocCpuTime, ocOnEnd, ocNone }
	The output control options. More...

Public Member Functions
	outputFilterOutputControl (const Time &, const dictionary &, const word &prefix)
	Construct from Time object and dictionary. More...
	~outputFilterOutputControl ()
	Destructor. More...
void	read (const dictionary &)
	Read from dictionary. More...
const Time &	time () const
	Return const access to the Time object. More...
bool	output ()
	Flag to indicate whether to output. More...
outputControls	outputControl () const
	Return outputControl. More...
scalar	writeInterval () const
	Return writeInterval. More...
label	outputTimeLastDump () const
	Return outputTimeLastDump. More...

Private Member Functions
	outputFilterOutputControl (const outputFilterOutputControl &)
	Disallow default bitwise copy construct and assignment. More...
void	operator= (const outputFilterOutputControl &)

Private Attributes
const Time &	time_
	Time object. More...
const word	prefix_
	Prefix. More...
outputControls	outputControl_
	Type of output. More...
label	outputInterval_
	The execution interval (in time steps) when using timeStep mode,. More...
label	outputTimeLastDump_
	Dumping counter for ocOutputTime or index dump for ocAdjustableTime. More...
scalar	writeInterval_
	Dump each deltaT (adjust Ttime) More...

Static Private Attributes
static const NamedEnum< outputControls, 8 >	outputControlNames_
	String representation of outputControls enums. More...

Detailed Description

An output control for function objects. The default is time-step execution at every interval.

Source files

• outputFilterOutputControl.H
• outputFilterOutputControl.C

Definition at line 51 of file outputFilterOutputControl.H.

Member Enumeration Documentation

outputControls

enum outputControls

The output control options.

Enumerator
ocTimeStep	execution is coupled to the time-step
ocOutputTime	execution is coupled to the output-time
ocAdjustableTime	Adjust time step for dumping
ocRunTime	run time for dumping
ocClockTime	clock time for dumping
ocCpuTime	cpu time for dumping
ocOnEnd	on end of run
ocNone	no output

Definition at line 56 of file outputFilterOutputControl.H.

Constructor & Destructor Documentation

outputFilterOutputControl() [1/2]

outputFilterOutputControl ( const outputFilterOutputControl &  )

private

Disallow default bitwise copy construct and assignment.

outputFilterOutputControl() [2/2]

outputFilterOutputControl	(	const Time &	t,
		const dictionary &	dict,
		const word &	prefix
	)

Construct from Time object and dictionary.

Definition at line 55 of file outputFilterOutputControl.C.

References dict, and Foam::read().

Here is the call graph for this function:

~outputFilterOutputControl()

~outputFilterOutputControl

(

)

Destructor.

Definition at line 74 of file outputFilterOutputControl.C.

Member Function Documentation

operator=()

void operator= ( const outputFilterOutputControl &  )

private

read()

void read

(

const dictionary &

dict

)

Read from dictionary.

Definition at line 80 of file outputFilterOutputControl.C.

References dict, dictionary::found(), dictionary::lookup(), dictionary::lookupOrDefault(), and Foam::readScalar().

Here is the call graph for this function:

time()

const Time& time ( ) const

inline

Return const access to the Time object.

Definition at line 126 of file outputFilterOutputControl.H.

References outputFilterOutputControl::time_.

output()

bool output

(

)

Flag to indicate whether to output.

Definition at line 127 of file outputFilterOutputControl.C.

References Foam::abort(), Foam::FatalError, FatalErrorInFunction, Foam::nl, and Foam::returnReduce().

Here is the call graph for this function:

outputControl()

outputControls outputControl ( ) const

inline

Return outputControl.

Definition at line 135 of file outputFilterOutputControl.H.

References outputFilterOutputControl::outputControl_.

writeInterval()

scalar writeInterval ( ) const

inline

Return writeInterval.

Definition at line 141 of file outputFilterOutputControl.H.

References outputFilterOutputControl::writeInterval_.

outputTimeLastDump()

label outputTimeLastDump ( ) const

inline

Return outputTimeLastDump.

Definition at line 147 of file outputFilterOutputControl.H.

References outputFilterOutputControl::outputTimeLastDump_.

Field Documentation

time_

const Time& time_

private

Time object.

Definition at line 74 of file outputFilterOutputControl.H.

Referenced by outputFilterOutputControl::time().

prefix_

const word prefix_

private

Prefix.

Definition at line 77 of file outputFilterOutputControl.H.

outputControlNames_

const Foam::NamedEnum< Foam::outputFilterOutputControl::outputControls, 8 > outputControlNames_

staticprivate

String representation of outputControls enums.

Definition at line 80 of file outputFilterOutputControl.H.

outputControl_

outputControls outputControl_

private

Type of output.

Definition at line 83 of file outputFilterOutputControl.H.

Referenced by outputFilterOutputControl::outputControl().

outputInterval_

label outputInterval_

private

The execution interval (in time steps) when using timeStep mode,.

a value <= 1 means execute at every time step

Definition at line 87 of file outputFilterOutputControl.H.

outputTimeLastDump_

label outputTimeLastDump_

private

Dumping counter for ocOutputTime or index dump for ocAdjustableTime.

Definition at line 90 of file outputFilterOutputControl.H.

Referenced by outputFilterOutputControl::outputTimeLastDump().

writeInterval_

scalar writeInterval_

private

Dump each deltaT (adjust Ttime)

Definition at line 93 of file outputFilterOutputControl.H.

Referenced by outputFilterOutputControl::writeInterval().

---

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

• src/OpenFOAM/db/functionObjects/outputFilterOutputControl/outputFilterOutputControl.H
• src/OpenFOAM/db/functionObjects/outputFilterOutputControl/outputFilterOutputControl.C