Returns a 0/1 value corresponding to function object trigger levels. More...

Inheritance diagram for FunctionObjectTrigger< Type >:

Collaboration diagram for FunctionObjectTrigger< Type >:

Public Member Functions
	TypeName ("functionObjectTrigger")
	Runtime type information. More...

void	operator= (const FunctionObjectTrigger< Type > &)=delete
	No copy assignment. More...

	FunctionObjectTrigger (const word &entryName, const dictionary &dict, const objectRegistry *obrPtr=nullptr)
	Construct from entry name, dictionary and optional registry. More...

	FunctionObjectTrigger (const FunctionObjectTrigger< Type > &rhs)
	Copy construct. More...

virtual tmp< Function1< Type > >	clone () const
	Construct and return a clone. More...

virtual	~FunctionObjectTrigger ()=default
	Destructor. More...

const labelList &	triggers () const noexcept
	Return the trigger indices. More...

void	resetTriggers (const labelUList &indices)
	Change the trigger indices. More...

virtual Type	value (const scalar) const
	Return 0/1 value at current time. More...

virtual Type	integrate (const scalar, const scalar) const
	Integrate between two (scalar) values. Not implemented! More...

virtual void	writeData (Ostream &os) const
	Write in dictionary format. More...

virtual void	writeEntries (Ostream &os) const
	Write coefficient entries in dictionary format. More...

Public Member Functions inherited from Function1< Type >
	TypeName ("Function1") declareRunTimeSelectionTable(autoPtr
	Runtime type information. More...

	Function1 (const word &entryName, const objectRegistry *obrPtr=nullptr)
	Construct from entry name. More...

	Function1 (const word &entryName, const dictionary &dict, const objectRegistry *obrPtr=nullptr)

	Function1 (const Function1< Type > &rhs)
	Copy construct. More...

virtual tmp< Function1< Type > >	clone () const =0
	Construct and return a clone. More...

virtual	~Function1 ()=default
	Destructor. More...

virtual bool	constant () const
	Is value constant (i.e. independent of x) More...

virtual bool	good () const
	Can function be evaluated? More...

virtual Type	value (const scalar x) const
	Return value as a function of (scalar) independent variable. More...

virtual tmp< Field< Type > >	value (const scalarField &x) const
	Return value as a function of (scalar) independent variable. More...

virtual Type	integrate (const scalar x1, const scalar x2) const
	Integrate between two (scalar) values. More...

virtual tmp< Field< Type > >	integrate (const scalarField &x1, const scalarField &x2) const
	Integrate between two (scalar) values. More...

virtual void	writeData (Ostream &os) const
	Write in dictionary format. More...

virtual void	writeEntries (Ostream &os) const
	Write coefficient entries in dictionary format. More...

Public Member Functions inherited from function1Base
	function1Base (const word &entryName, const objectRegistry *obrPtr=nullptr)
	Construct from entry name and optional registry. More...

	function1Base (const word &entryName, const dictionary &dict, const objectRegistry *obrPtr=nullptr)
	Construct from entry name, dictionary (unused) and optional registry. More...

	function1Base (const function1Base &rhs)
	Copy construct. More...

virtual	~function1Base ()
	Destructor. More...

const word &	name () const noexcept
	The name of the entry. More...

const objectRegistry *	whichDb () const noexcept
	Return the associated registry or nullptr. More...

void	resetDb (const objectRegistry *obrPtr=nullptr) noexcept
	Reset the associated objectRegistry. More...

void	resetDb (const objectRegistry &db) noexcept
	Reset the associated objectRegistry. More...

const objectRegistry &	obr () const
	Return the object registry. More...

bool	isTime () const noexcept
	Return true if this function was created with the time database. More...

const Time &	time () const
	Return the time database. More...

template<class MeshType >
const MeshType &	mesh (const word &regionName=word::null) const
	Return the mesh database if this Function1 was created using a mesh. More...

virtual void	userTimeToTime (const Time &t)
	Convert time. More...

Public Member Functions inherited from refCount
constexpr	refCount () noexcept
	Default construct, initializing count to 0. More...

int	count () const noexcept
	Return the current reference count. More...

bool	unique () const noexcept
	Return true if the reference count is zero. More...

void	operator++ () noexcept
	Increment the reference count. More...

void	operator++ (int) noexcept
	Increment the reference count. More...

void	operator-- () noexcept
	Decrement the reference count. More...

void	operator-- (int) noexcept
	Decrement the reference count. More...

Additional Inherited Members
Public Types inherited from Function1< Type >
typedef Type	returnType

Static Public Member Functions inherited from Function1< Type >
static autoPtr< Function1< Type > >	New (const word &entryName, const dictionary &dict, const word &redirectType, const objectRegistry *obrPtr=nullptr, const bool mandatory=true)
	Selector, with fallback redirection. More...

static autoPtr< Function1< Type > >	NewCompat (const word &entryName, std::initializer_list< std::pair< const char , int > > compat, const dictionary &dict, const word &redirectType=word::null, const objectRegistry obrPtr=nullptr, const bool mandatory=true)
	Compatibility selector, with fallback redirection. More...

static autoPtr< Function1< Type > >	New (const word &entryName, const dictionary &dict, const objectRegistry *obrPtr=nullptr, const bool mandatory=true)
	Selector, without fallback redirection. More...

static autoPtr< Function1< Type > >	NewIfPresent (const word &entryName, const dictionary &dict, const word &redirectType=word::null, const objectRegistry *obrPtr=nullptr)
	An optional selector. More...

static refPtr< Function1< Type > >	New (HashPtrTable< Function1< Type > > &cache, const word &entryName, const dictionary &dict, enum keyType::option matchOpt=keyType::LITERAL, const objectRegistry *obrPtr=nullptr, const bool mandatory=true)

Public Attributes inherited from Function1< Type >
	Function1

	dictionary

const word &	entryName

const word const dictionary &	dict

const word const dictionary const objectRegistry *	obrPtr

const word const dictionary const objectRegistry	entryName

const word const dictionary const objectRegistry	dict

const word const dictionary const objectRegistry	obrPtr

Protected Member Functions inherited from Function1< Type >
void	operator= (const Function1< Type > &)=delete
	No copy assignment. More...

Protected Member Functions inherited from function1Base
void	operator= (const function1Base &)=delete
	No copy assignment. More...

Protected Attributes inherited from function1Base
const word	name_
	Name of entry. More...

const objectRegistry *	obrPtr_
	Pointer to an object registry. More...

Detailed Description

template<class Type>
class Foam::Function1Types::FunctionObjectTrigger< Type >

Returns a 0/1 value corresponding to function object trigger levels.

Usage:

    <entryName> functionObjectTrigger;
    <entryName>Coeffs
    {
        triggers        (1 3 5);
        defaultValue    false;  // Optional
    }

Where:

Property	Description	Required
`triggers`	List of active trigger states to check for	yes
`defaultValue`	Treatment for unactivated trigger state	no	false

In some circumstances, it can be useful to treat an unactivated trigger as being true. This is the role of the "defaultValue" keyword.

Note

does not implement integrate()

Source files

Definition at line 92 of file FunctionObjectTrigger.H.

Constructor & Destructor Documentation

◆ FunctionObjectTrigger() [1/2]

FunctionObjectTrigger	(	const word &	entryName,
		const dictionary &	dict,
		const objectRegistry *	obrPtr = `nullptr`
	)

Construct from entry name, dictionary and optional registry.

Definition at line 45 of file FunctionObjectTrigger.C.

References Function1< Type >::dict.

◆ FunctionObjectTrigger() [2/2]

FunctionObjectTrigger ( const FunctionObjectTrigger< Type > & rhs )

explicit

Copy construct.

Definition at line 61 of file FunctionObjectTrigger.C.

◆ ~FunctionObjectTrigger()

virtual ~FunctionObjectTrigger ( )

virtualdefault

Destructor.

Member Function Documentation

◆ TypeName()

TypeName ( "functionObjectTrigger" )

Runtime type information.

◆ operator=()

void operator= ( const FunctionObjectTrigger< Type > & )

delete

No copy assignment.

◆ clone()

virtual tmp< Function1< Type > > clone ( ) const

inlinevirtual

Construct and return a clone.

Implements Function1< Type >.

Definition at line 141 of file FunctionObjectTrigger.H.

◆ triggers()

const Foam::labelList & triggers

inlinenoexcept

Return the trigger indices.

Definition at line 51 of file FunctionObjectTriggerI.H.

◆ resetTriggers()

void resetTriggers ( const labelUList & indices )

inline

Change the trigger indices.

Definition at line 58 of file FunctionObjectTriggerI.H.

◆ value()

Type value ( const scalar ) const

inlinevirtual

Return 0/1 value at current time.

Reimplemented from Function1< Type >.

Definition at line 68 of file FunctionObjectTriggerI.H.

◆ integrate()

Type integrate	(	const scalar	x1,
		const scalar	x2
	)		const

inlinevirtual

Integrate between two (scalar) values. Not implemented!

Reimplemented from Function1< Type >.

Definition at line 78 of file FunctionObjectTriggerI.H.

References NotImplemented.

◆ writeData()

void writeData ( Ostream & os ) const

virtual

Write in dictionary format.

Reimplemented from Function1< Type >.

Definition at line 92 of file FunctionObjectTrigger.C.

References Foam::name(), and os().

Here is the call graph for this function:

◆ writeEntries()

void writeEntries ( Ostream & os ) const

virtual

Write coefficient entries in dictionary format.

Reimplemented from Function1< Type >.

Definition at line 75 of file FunctionObjectTrigger.C.

References Foam::flatOutput(), and os().

Here is the call graph for this function:

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

src/OpenFOAM/primitives/functions/Function1/FunctionObjectTrigger/FunctionObjectTrigger.H
src/OpenFOAM/primitives/functions/Function1/FunctionObjectTrigger/FunctionObjectTrigger.C
src/OpenFOAM/primitives/functions/Function1/FunctionObjectTrigger/FunctionObjectTriggerI.H

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ FunctionObjectTrigger() [1/2]

◆ FunctionObjectTrigger() [2/2]

◆ ~FunctionObjectTrigger()

Member Function Documentation

◆ TypeName()

◆ operator=()

◆ clone()

◆ triggers()

◆ resetTriggers()

◆ value()

◆ integrate()

◆ writeData()

◆ writeEntries()