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

#include <FunctionObjectTrigger.H>

Inheritance diagram for FunctionObjectTrigger< Type >:

Collaboration diagram for FunctionObjectTrigger< Type >:

Public Member Functions
	TypeName ("functionObjectTrigger")
	Runtime type information.
void	operator= (const FunctionObjectTrigger< Type > &)=delete
	No copy assignment.
	FunctionObjectTrigger (const word &entryName, const dictionary &dict, const objectRegistry *obrPtr=nullptr)
	Construct from entry name, dictionary and optional registry.
	FunctionObjectTrigger (const FunctionObjectTrigger< Type > &rhs)
	Copy construct.
virtual tmp< Function1< Type > >	clone () const
	Return a clone.
virtual	~FunctionObjectTrigger ()=default
	Destructor.
const labelList &	triggers () const noexcept
	Return the trigger indices.
void	resetTriggers (const labelUList &indices)
	Change the trigger indices.
virtual Type	value (const scalar) const
	Return 0/1 value at current time.
virtual Type	integrate (const scalar, const scalar) const
	Integrate between two (scalar) values. Not implemented!
virtual void	writeData (Ostream &os) const
	Write in dictionary format.
virtual void	writeEntries (Ostream &os) const
	Write coefficient entries in dictionary format.
const::Foam::word	typeName (Function1Types::FunctionObjectTrigger< label >::typeName_())
int	debug (::Foam::debug::debugSwitch(Function1Types::FunctionObjectTrigger< label >::typeName_(), 0))
const::Foam::word	typeName (Function1Types::FunctionObjectTrigger< scalar >::typeName_())
int	debug (::Foam::debug::debugSwitch(Function1Types::FunctionObjectTrigger< scalar >::typeName_(), 0))
Public Member Functions inherited from Function1< Type >
virtual const word &	type () const
	Function1 (const word &entryName, const objectRegistry *obrPtr=nullptr)
	Construct from entry name.
	Function1 (const word &entryName, const dictionary &dict, const objectRegistry *obrPtr=nullptr)
	Construct from entry name, (unused) dictionary and optional registry.
	Function1 (const Function1< Type > &rhs)
	Copy construct.
virtual	~Function1 ()=default
	Destructor.
virtual bool	constant () const
	Is value constant (i.e. independent of x).
virtual bool	good () const
	Can function be evaluated?
virtual tmp< Field< Type > >	value (const scalarField &x) const
	Return value as a function of (scalar) independent variable.
virtual tmp< Field< Type > >	integrate (const scalarField &x1, const scalarField &x2) const
	Integrate between two (scalar) values.
const::Foam::word	typeName (Function1< label >::typeName_())
int	debug (::Foam::debug::debugSwitch(Function1< label >::typeName_(), 0))
Function1< label >::dictionaryConstructorTableType *	dictionaryConstructorTablePtr_ (nullptr)
std::unique_ptr< Function1< label >::dictionaryConstructorCompatTableType >	dictionaryConstructorCompatTablePtr_ (nullptr)
Function1< label >::dictionaryConstructorCompatTableType &	dictionaryConstructorCompatTable ()
void	dictionaryConstructorTablePtr_construct (bool load)
Function1< label >::dictionaryConstructorPtr	dictionaryConstructorTable (const::Foam::word &k)
const::Foam::word	typeName (Function1< scalar >::typeName_())
int	debug (::Foam::debug::debugSwitch(Function1< scalar >::typeName_(), 0))
Function1< scalar >::dictionaryConstructorTableType *	dictionaryConstructorTablePtr_ (nullptr)
std::unique_ptr< Function1< scalar >::dictionaryConstructorCompatTableType >	dictionaryConstructorCompatTablePtr_ (nullptr)
Function1< scalar >::dictionaryConstructorCompatTableType &	dictionaryConstructorCompatTable ()
void	dictionaryConstructorTablePtr_construct (bool load)
Function1< scalar >::dictionaryConstructorPtr	dictionaryConstructorTable (const::Foam::word &k)
const::Foam::word	typeName (Function1< vector >::typeName_())
int	debug (::Foam::debug::debugSwitch(Function1< vector >::typeName_(), 0))
Function1< vector >::dictionaryConstructorTableType *	dictionaryConstructorTablePtr_ (nullptr)
std::unique_ptr< Function1< vector >::dictionaryConstructorCompatTableType >	dictionaryConstructorCompatTablePtr_ (nullptr)
Function1< vector >::dictionaryConstructorCompatTableType &	dictionaryConstructorCompatTable ()
void	dictionaryConstructorTablePtr_construct (bool load)
Function1< vector >::dictionaryConstructorPtr	dictionaryConstructorTable (const::Foam::word &k)
const::Foam::word	typeName (Function1< sphericalTensor >::typeName_())
int	debug (::Foam::debug::debugSwitch(Function1< sphericalTensor >::typeName_(), 0))
Function1< sphericalTensor >::dictionaryConstructorTableType *	dictionaryConstructorTablePtr_ (nullptr)
std::unique_ptr< Function1< sphericalTensor >::dictionaryConstructorCompatTableType >	dictionaryConstructorCompatTablePtr_ (nullptr)
Function1< sphericalTensor >::dictionaryConstructorCompatTableType &	dictionaryConstructorCompatTable ()
void	dictionaryConstructorTablePtr_construct (bool load)
Function1< sphericalTensor >::dictionaryConstructorPtr	dictionaryConstructorTable (const::Foam::word &k)
const::Foam::word	typeName (Function1< symmTensor >::typeName_())
int	debug (::Foam::debug::debugSwitch(Function1< symmTensor >::typeName_(), 0))
Function1< symmTensor >::dictionaryConstructorTableType *	dictionaryConstructorTablePtr_ (nullptr)
std::unique_ptr< Function1< symmTensor >::dictionaryConstructorCompatTableType >	dictionaryConstructorCompatTablePtr_ (nullptr)
Function1< symmTensor >::dictionaryConstructorCompatTableType &	dictionaryConstructorCompatTable ()
void	dictionaryConstructorTablePtr_construct (bool load)
Function1< symmTensor >::dictionaryConstructorPtr	dictionaryConstructorTable (const::Foam::word &k)
const::Foam::word	typeName (Function1< tensor >::typeName_())
int	debug (::Foam::debug::debugSwitch(Function1< tensor >::typeName_(), 0))
Function1< tensor >::dictionaryConstructorTableType *	dictionaryConstructorTablePtr_ (nullptr)
std::unique_ptr< Function1< tensor >::dictionaryConstructorCompatTableType >	dictionaryConstructorCompatTablePtr_ (nullptr)
Function1< tensor >::dictionaryConstructorCompatTableType &	dictionaryConstructorCompatTable ()
void	dictionaryConstructorTablePtr_construct (bool load)
Function1< tensor >::dictionaryConstructorPtr	dictionaryConstructorTable (const::Foam::word &k)
const::Foam::word	typeName (Function1< scalarField >::typeName_())
int	debug (::Foam::debug::debugSwitch(Function1< scalarField >::typeName_(), 0))
Function1< scalarField >::dictionaryConstructorTableType *	dictionaryConstructorTablePtr_ (nullptr)
std::unique_ptr< Function1< scalarField >::dictionaryConstructorCompatTableType >	dictionaryConstructorCompatTablePtr_ (nullptr)
Function1< scalarField >::dictionaryConstructorCompatTableType &	dictionaryConstructorCompatTable ()
void	dictionaryConstructorTablePtr_construct (bool load)
Function1< scalarField >::dictionaryConstructorPtr	dictionaryConstructorTable (const::Foam::word &k)
Public Member Functions inherited from function1Base
	function1Base (const word &entryName, const objectRegistry *obrPtr=nullptr)
	Construct from entry name and optional registry.
	function1Base (const word &entryName, const dictionary &dict, const objectRegistry *obrPtr=nullptr)
	Construct from entry name, dictionary (unused) and optional registry.
	function1Base (const function1Base &rhs)
	Copy construct.
virtual	~function1Base ()
	Destructor.
const word &	name () const noexcept
	The name of the entry.
const objectRegistry *	whichDb () const noexcept
	Return the associated registry or nullptr.
void	resetDb (const objectRegistry *obrPtr=nullptr) noexcept
	Reset the associated objectRegistry.
void	resetDb (const objectRegistry &db) noexcept
	Reset the associated objectRegistry.
const objectRegistry &	obr () const
	Return the object registry.
bool	isTime () const noexcept
	Return true if this function was created with the time database.
const Time &	time () const
	Return the time database.
template<class MeshType>
const MeshType &	mesh (const word &regionName=word::null) const
	Return the mesh database if this Function1 was created using a mesh.
virtual void	userTimeToTime (const Time &t)
	Convert time.
Public Member Functions inherited from refCount
constexpr	refCount () noexcept
	Default construct, initializing count to 0.
int	use_count () const noexcept
	Return the current reference count.
bool	unique () const noexcept
	Return true if the reference count is zero.
void	operator++ () noexcept
	Increment the reference count.
void	operator++ (int) noexcept
	Increment the reference count.
void	operator-- () noexcept
	Decrement the reference count.
void	operator-- (int) noexcept
	Decrement the reference count.

Additional Inherited Members
Public Types inherited from Function1< Type >
typedef Type	returnType
	The return type.
typedef autoPtr< Function1 >(*	dictionaryConstructorPtr) (const word &entryName, const dictionary &dict, const objectRegistry *obrPtr)
	Declare runtime constructor selection table.
typedef ::Foam::HashTable< dictionaryConstructorPtr, ::Foam::word, ::Foam::Hash<::Foam::word > >	dictionaryConstructorTableType
typedef ::Foam::HashTable< std::pair<::Foam::word, int >, ::Foam::word, ::Foam::Hash<::Foam::word > >	dictionaryConstructorCompatTableType
Static Public Member Functions inherited from Function1< Type >
static const char *	typeName_ ()
	Runtime type information.
static dictionaryConstructorCompatTableType &	dictionaryConstructorCompatTable ()
static void	dictionaryConstructorTablePtr_construct (bool load)
static dictionaryConstructorPtr	dictionaryConstructorTable (const ::Foam::word &k)
template<class Derived>
static tmp< Function1< Type > >	Clone (const Derived &fun)
	Clone a Function1.
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.
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.
static autoPtr< Function1< Type > >	New (const word &entryName, const dictionary &dict, const objectRegistry *obrPtr=nullptr, const bool mandatory=true)
	Selector, without fallback redirection.
static autoPtr< Function1< Type > >	NewIfPresent (const word &entryName, const dictionary &dict, const word &redirectType, const objectRegistry *obrPtr=nullptr)
	An optional selector, with fallback redirection.
static autoPtr< Function1< Type > >	NewIfPresent (const word &entryName, const dictionary &dict, const objectRegistry *obrPtr=nullptr)
	An optional selector, without fallback redirection.
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)
	Selector with external storage of Function1. This also allows wildcard matches in a dictionary.
Static Public Attributes inherited from Function1< Type >
static const ::Foam::word	typeName
static int	debug
static dictionaryConstructorTableType *	dictionaryConstructorTablePtr_
static std::unique_ptr< dictionaryConstructorCompatTableType >	dictionaryConstructorCompatTablePtr_
Protected Member Functions inherited from Function1< Type >
void	operator= (const Function1< Type > &)=delete
	No copy assignment.
Protected Member Functions inherited from function1Base
void	operator= (const function1Base &)=delete
	No copy assignment.
Protected Attributes inherited from function1Base
const word	name_
	Name of entry.
const objectRegistry *	obrPtr_
	Pointer to an object registry.

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 88 of file FunctionObjectTrigger.H.

Constructor & Destructor Documentation

◆ FunctionObjectTrigger() [1/2]

template<class Type>

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

Construct from entry name, dictionary and optional registry.

Definition at line 38 of file FunctionObjectTrigger.C.

References dict, and Function1< Type >::Function1().

Referenced by debug(), debug(), FunctionObjectTrigger(), and operator=().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ FunctionObjectTrigger() [2/2]

template<class Type>

FunctionObjectTrigger ( const FunctionObjectTrigger< Type > & rhs )

explicit

Copy construct.

Definition at line 54 of file FunctionObjectTrigger.C.

References Function1< Type >::Function1(), FunctionObjectTrigger(), and Foam::rhs().

Here is the call graph for this function:

◆ ~FunctionObjectTrigger()

template<class Type>

virtual ~FunctionObjectTrigger ( )

virtualdefault

Destructor.

References integrate(), Foam::noexcept, os(), resetTriggers(), value(), writeData(), and writeEntries().

Here is the call graph for this function:

Member Function Documentation

◆ TypeName()

template<class Type>

TypeName ( "functionObjectTrigger" )

Runtime type information.

◆ operator=()

template<class Type>

void operator= ( const FunctionObjectTrigger< Type > & )

delete

No copy assignment.

References dict, FunctionObjectTrigger(), and Foam::rhs().

Here is the call graph for this function:

◆ clone()

template<class Type>

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

inlinevirtual

Return a clone.

Implements Function1< Type >.

Definition at line 154 of file FunctionObjectTrigger.H.

References Function1< Type >::Clone().

Here is the call graph for this function:

◆ triggers()

template<class Type>

const Foam::labelList & triggers ( ) const

inlinenoexcept

Return the trigger indices.

Definition at line 44 of file FunctionObjectTriggerI.H.

References Foam::noexcept.

◆ resetTriggers()

template<class Type>

void resetTriggers ( const labelUList & indices )

inline

Change the trigger indices.

Definition at line 51 of file FunctionObjectTriggerI.H.

Referenced by ~FunctionObjectTrigger().

Here is the caller graph for this function:

◆ value()

template<class Type>

Type value ( const scalar ) const

inlinevirtual

Return 0/1 value at current time.

Reimplemented from Function1< Type >.

Definition at line 61 of file FunctionObjectTriggerI.H.

Referenced by ~FunctionObjectTrigger().

Here is the caller graph for this function:

◆ integrate()

template<class Type>

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

inlinevirtual

Integrate between two (scalar) values. Not implemented!

Reimplemented from Function1< Type >.

Definition at line 71 of file FunctionObjectTriggerI.H.

References NotImplemented.

Referenced by ~FunctionObjectTrigger().

Here is the caller graph for this function:

◆ writeData()

template<class Type>

void writeData ( Ostream & os ) const

virtual

Write in dictionary format.

Reimplemented from Function1< Type >.

Definition at line 85 of file FunctionObjectTrigger.C.

References name, os(), Function1< Type >::writeData(), and writeEntries().

Referenced by ~FunctionObjectTrigger().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ writeEntries()

template<class Type>

void writeEntries ( Ostream & os ) const

virtual

Write coefficient entries in dictionary format.

Reimplemented from Function1< Type >.

Definition at line 68 of file FunctionObjectTrigger.C.

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

Referenced by writeData(), and ~FunctionObjectTrigger().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ typeName() [1/2]

const::Foam::word typeName ( Function1Types::FunctionObjectTrigger< label > ::typeName_() )

◆ debug() [1/2]

int debug ( ::Foam::debug::debugSwitch(Function1Types::FunctionObjectTrigger< label >::typeName_(), 0) )

References FunctionObjectTrigger().

Here is the call graph for this function:

◆ typeName() [2/2]

const::Foam::word typeName ( Function1Types::FunctionObjectTrigger< scalar > ::typeName_() )

◆ debug() [2/2]

int debug ( ::Foam::debug::debugSwitch(Function1Types::FunctionObjectTrigger< scalar >::typeName_(), 0) )

References FunctionObjectTrigger().

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()

◆ typeName() [1/2]

◆ debug() [1/2]

◆ typeName() [2/2]

◆ debug() [2/2]