Minimum or maximum initial residual run time condition. More...

#include <equationInitialResidualCondition.H>

Inheritance diagram for equationInitialResidualCondition:

Collaboration diagram for equationInitialResidualCondition:

[legend]

Public Types
enum	operatingMode { omMin , omMax }

Public Member Functions
	TypeName ("equationInitialResidual")
	Runtime type information.
	equationInitialResidualCondition (const word &name, const objectRegistry &obr, const dictionary &dict, stateFunctionObject &state)
	Constructor.
virtual	~equationInitialResidualCondition ()=default
	Destructor.
virtual bool	apply ()
	Apply the condition.
virtual void	write ()
	Write.
virtual void	reset ()
	Reset.
Public Member Functions inherited from runTimeCondition
	TypeName ("runTimeCondition")
	Runtime type information.
	declareRunTimeSelectionTable (autoPtr, runTimeCondition, dictionary,(const word &name, const objectRegistry &obr, const dictionary &dict, stateFunctionObject &state),(name, obr, dict, state))
	Declare runtime constructor selection table.
	runTimeCondition (const word &name, const objectRegistry &obr, const dictionary &dict, stateFunctionObject &state)
	Constructor.
virtual	~runTimeCondition ()=default
	Destructor.
virtual const word &	name () const
	Return the condition name.
virtual bool	active () const
	Return the active flag.
virtual label	groupID () const
	Return the group index.

Static Public Attributes
static const Enum< operatingMode >	operatingModeNames

Protected Member Functions
template<class Type>
void	setResidual (const fvMesh &mesh, const dictionary &dict, const word &fieldName, const label componenti, bool &canSet, scalar &residual) const
	Set the residual (scalar) value.
Protected Member Functions inherited from runTimeCondition
dictionary &	setConditionDict ()
	Set the condition dictionary (create if necessary).
const dictionary &	conditionDict () const
	Return const access to the conditions dictionary.
dictionary &	conditionDict ()
	Return non-const access to the conditions dictionary.

Protected Attributes
solverFieldSelection	fieldSelection_
	Field names.
const scalar	value_
	Value to compare.
scalar	timeStart_
	Start checking from time - always skips first iteration.
operatingMode	mode_
	Operating mode.
Protected Attributes inherited from runTimeCondition
word	name_
	Condition name.
const objectRegistry &	obr_
	Reference to the object registry.
stateFunctionObject &	state_
	State.
bool	active_
	On/off switch.
dictionary &	conditionDict_
	Reference to the condition dictionary.
label	groupID_
	Group index - if applied, all conditions in a group must be.

Additional Inherited Members
Static Public Member Functions inherited from runTimeCondition
static autoPtr< runTimeCondition >	New (const word &conditionName, const objectRegistry &obr, const dictionary &dict, stateFunctionObject &state)
	Selector.
Public Attributes inherited from runTimeCondition
Switch	log
	Switch to send output to Info.

Detailed Description

Minimum or maximum initial residual run time condition.

Source files

Definition at line 56 of file equationInitialResidualCondition.H.

Member Enumeration Documentation

◆ operatingMode

enum operatingMode

Enumerator
omMin	Minimum.
omMax	Maximum.

Definition at line 62 of file equationInitialResidualCondition.H.

Constructor & Destructor Documentation

◆ equationInitialResidualCondition()

equationInitialResidualCondition	(	const word &	name,
		const objectRegistry &	obr,
		const dictionary &	dict,
		stateFunctionObject &	state )

Constructor.

Definition at line 69 of file equationInitialResidualCondition.C.

References dict, fieldSelection_, mode_, runTimeCondition::name(), operatingModeNames, runTimeCondition::runTimeCondition(), timeStart_, and value_.

Here is the call graph for this function:

◆ ~equationInitialResidualCondition()

virtual ~equationInitialResidualCondition ( )

virtualdefault

Destructor.

Member Function Documentation

◆ setResidual()

template<class Type>

void setResidual	(	const fvMesh &	mesh,
		const dictionary &	dict,
		const word &	fieldName,
		const label	componenti,
		bool &	canSet,
		scalar &	residual ) const

protected

Set the residual (scalar) value.

Definition at line 24 of file equationInitialResidualConditionTemplates.C.

References Foam::cmptMax(), Foam::component(), dict, Foam::exit(), Foam::FatalError, FatalErrorInFunction, Pair< T >::first(), and mesh.

Here is the call graph for this function:

◆ TypeName()

TypeName ( "equationInitialResidual" )

Runtime type information.

References dict, and runTimeCondition::name().

Here is the call graph for this function:

◆ apply()

bool apply ( )

virtual

Apply the condition.

Implements runTimeCondition.

Definition at line 102 of file equationInitialResidualCondition.C.

References Foam::abort(), runTimeCondition::active_, Foam::component(), fieldInfo::component(), Foam::endl(), Foam::FatalError, FatalErrorInFunction, fieldSelection_, forAll, dictionary::found(), Log, mesh, mode_, fieldInfo::name(), runTimeCondition::name_, Foam::nl, runTimeCondition::obr_, omMax, omMin, operatingModeNames, Foam::refCast(), SetResidual, dictionary::sortedToc(), timeStart_, Foam::type(), value_, and WarningInFunction.

Here is the call graph for this function:

◆ write()

void write ( )

virtual

Write.

Implements runTimeCondition.

Definition at line 219 of file equationInitialResidualCondition.C.

◆ reset()

void reset ( )

virtual

Reset.

Implements runTimeCondition.

Definition at line 226 of file equationInitialResidualCondition.C.

Member Data Documentation

◆ operatingModeNames

const Foam::Enum< Foam::functionObjects::runTimeControls::equationInitialResidualCondition::operatingMode > operatingModeNames

static

Definition at line 68 of file equationInitialResidualCondition.H.

Referenced by apply(), and equationInitialResidualCondition().

◆ fieldSelection_

solverFieldSelection fieldSelection_

protected

Field names.

Definition at line 78 of file equationInitialResidualCondition.H.

Referenced by apply(), and equationInitialResidualCondition().

◆ value_

const scalar value_

protected

Value to compare.

Definition at line 83 of file equationInitialResidualCondition.H.

Referenced by apply(), and equationInitialResidualCondition().

◆ timeStart_

scalar timeStart_

protected

Start checking from time - always skips first iteration.

Definition at line 88 of file equationInitialResidualCondition.H.

Referenced by apply(), and equationInitialResidualCondition().

◆ mode_

operatingMode mode_

protected

Operating mode.

Definition at line 93 of file equationInitialResidualCondition.H.

Referenced by apply(), and equationInitialResidualCondition().

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

src/functionObjects/utilities/runTimeControl/runTimeCondition/equationInitialResidualCondition/equationInitialResidualCondition.H
src/functionObjects/utilities/runTimeControl/runTimeCondition/equationInitialResidualCondition/equationInitialResidualCondition.C
src/functionObjects/utilities/runTimeControl/runTimeCondition/equationInitialResidualCondition/equationInitialResidualConditionTemplates.C

Public Types

Public Member Functions

Static Public Attributes

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

◆ operatingMode

Constructor & Destructor Documentation

◆ equationInitialResidualCondition()

◆ ~equationInitialResidualCondition()

Member Function Documentation

◆ setResidual()

◆ TypeName()

◆ apply()

◆ write()

◆ reset()

Member Data Documentation

◆ operatingModeNames

◆ fieldSelection_

◆ value_

◆ timeStart_

◆ mode_