A dependency in which some attribute of a TwoDArray in a parameter depends on the value of another parameter. More...

#include <Teuchos_StandardDependencies.hpp>

Inheritance diagram for Teuchos::TwoDArrayModifierDependency< DependeeType, DependentType >:

Constructors/Destructor
	TwoDArrayModifierDependency (RCP< const ParameterEntry > dependee, RCP< ParameterEntry > dependent, RCP< const SimpleFunctionObject< DependeeType > > func=null)
	Constructs a TwoDArrayModifierDependency. More...

	TwoDArrayModifierDependency (RCP< const ParameterEntry > dependee, Dependency::ParameterEntryList dependents, RCP< const SimpleFunctionObject< DependeeType > > func=null)
	Constructs a TwoDArrayModifierDependency. More...

Overridden from ArrayModifierDependency
virtual void	validateDep () const

Additional Inherited Members
Public Types inherited from Teuchos::Dependency
typedef std::set< RCP< ParameterEntry >, RCPComp >	ParameterEntryList
	A list of Dependees. More...

typedef std::set< RCP< const ParameterEntry >, RCPConstComp >	ConstParameterEntryList
	A list of dependents. More...

Public Member Functions inherited from Teuchos::ArrayModifierDependency< DependeeType, DependentType >
	ArrayModifierDependency (RCP< const ParameterEntry > dependee, RCP< ParameterEntry > dependent, RCP< const SimpleFunctionObject< DependeeType > > func=null)
	Constructs an ArrayModifierDependency. More...

	ArrayModifierDependency (RCP< const ParameterEntry > dependee, ParameterEntryList dependents, RCP< const SimpleFunctionObject< DependeeType > > func=null)
	Constructs an ArrayModifierDependency. More...

RCP< const SimpleFunctionObject< DependeeType > >	getFunctionObject () const
	Retrieves the function being used to calculate the amount by which an arrays dimensional attribute should be modified. More...

virtual void	evaluate ()

Public Member Functions inherited from Teuchos::Dependency
	Dependency (ConstParameterEntryList dependees, ParameterEntryList dependents)
	Constructs a Dependency. More...

	Dependency (ConstParameterEntryList dependees, RCP< ParameterEntry > dependent)
	Constructs a Dependency. More...

	Dependency (RCP< const ParameterEntry > dependee, ParameterEntryList dependents)
	Constructs a Dependency. More...

	Dependency (RCP< const ParameterEntry > dependee, RCP< ParameterEntry > dependent)
	Constructs a Dependency. More...

const ConstParameterEntryList &	getDependees () const
	Gets the dependees of the dependency. More...

ParameterEntryList &	getDependents ()
	Gets the dependents of the dependency. More...

const ConstParameterEntryList &	getDependents () const
	Gets the dependents of the dependency. More...

RCP< const ParameterEntry >	getFirstDependee () const
	Gets the first dependee in the dependees list. This is a convience function. More...

template<class S >
S	getFirstDependeeValue () const
	Convienence function. Returns the first dependee in the list of dependees. More...

virtual std::string	getTypeAttributeValue () const =0
	Returns the string to be used for the value of the type attribute when converting the dependency to XML. More...

virtual void	print (std::ostream &out) const
	prints out information about the dependency. More...

Public Member Functions inherited from Teuchos::Describable
virtual std::string	description () const
	Return a simple one-line description of this object. More...

virtual void	describe (FancyOStream &out, const EVerbosityLevel verbLevel=verbLevel_default) const
	Print the object with some verbosity level to a FancyOStream. More...

void	describe (std::ostream &out, const EVerbosityLevel verbLevel=verbLevel_default) const
	Version of describe() that takes an std::ostream instead of a FancyOStream. More...

virtual	~Describable ()
	Destructor (marked virtual for memory safety of derived classes). More...

Public Member Functions inherited from Teuchos::LabeledObject
	LabeledObject ()
	Construct with an empty label. More...

virtual	~LabeledObject ()

virtual void	setObjectLabel (const std::string &objectLabel)
	Set the object label (see LabeledObject). More...

virtual std::string	getObjectLabel () const
	Get the object label (see LabeledObject). More...

Static Public Member Functions inherited from Teuchos::Dependency
static const std::string &	getXMLTagName ()
	Returns the XML tag to use when serializing Dependencies. More...

Static Public Attributes inherited from Teuchos::Describable
static const EVerbosityLevel	verbLevel_default = VERB_DEFAULT
	Default value for the `verbLevel` argument of describe(). More...

Protected Member Functions inherited from Teuchos::ArrayModifierDependency< DependeeType, DependentType >
virtual void	modifyArray (DependeeType newAmount, RCP< ParameterEntry > dependentToModify)=0
	Modifies a particular attribute of the array according to the specific semantics of the dependency. More...

virtual std::string	getBadDependentValueErrorMessage () const =0
	Returns the error message that should be displayed if the dependent has taken on a value that, when run through the funciton given in the constructor, returns a negative value. More...

Protected Member Functions inherited from Teuchos::Dependency
Related Functions inherited from Teuchos::Describable
DescribableStreamManipulatorState	describe (const Describable &describable, const EVerbosityLevel verbLevel=Describable::verbLevel_default)
	Describable output stream manipulator. More...

std::ostream &	operator<< (std::ostream &os, const DescribableStreamManipulatorState &d)
	Output stream operator for Describable manipulator. More...

Detailed Description

template<class DependeeType, class DependentType>
class Teuchos::TwoDArrayModifierDependency< DependeeType, DependentType >

A dependency in which some attribute of a TwoDArray in a parameter depends on the value of another parameter.

Definition at line 1833 of file Teuchos_StandardDependencies.hpp.

Constructor & Destructor Documentation

◆ TwoDArrayModifierDependency() [1/2]

template<class DependeeType , class DependentType >

Teuchos::TwoDArrayModifierDependency< DependeeType, DependentType >::TwoDArrayModifierDependency	(	RCP< const ParameterEntry >	dependee,
		RCP< ParameterEntry >	dependent,
		RCP< const SimpleFunctionObject< DependeeType > >	func = `null`
	)

inline

Constructs a TwoDArrayModifierDependency.

Parameters

dependee	The dependee parameter.
dependent	The dependent parameter.
func	A function specifying how the TwoDArrays new attribute's value should be calculated from the dependees value.

Definition at line 1850 of file Teuchos_StandardDependencies.hpp.

◆ TwoDArrayModifierDependency() [2/2]

template<class DependeeType , class DependentType >

Teuchos::TwoDArrayModifierDependency< DependeeType, DependentType >::TwoDArrayModifierDependency	(	RCP< const ParameterEntry >	dependee,
		Dependency::ParameterEntryList	dependents,
		RCP< const SimpleFunctionObject< DependeeType > >	func = `null`
	)

inline

Constructs a TwoDArrayModifierDependency.

Parameters

dependee	The dependee parameter.
dependents	The dependents.
func	A function specifying how the TwoDArrays new attribute's value should be calculated from the dependees value.

Definition at line 1869 of file Teuchos_StandardDependencies.hpp.