Teuchos Package Browser (Single Doxygen Collection) Version of the Day
Loading...
Searching...
No Matches
List of all members
Teuchos::TwoDColDependency< DependeeType, DependentType > Class Template Reference

A dependency in which the number of rows in a parameter with a TwoDArray depends on the value of another parameter. More...

#include <Teuchos_StandardDependencies.hpp>

Inheritance diagram for Teuchos::TwoDColDependency< DependeeType, DependentType >:
Inheritance graph
[legend]

Constructors/Destructor

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

Overridden from Dependency

std::string getTypeAttributeValue () const
 

Overridden from ArrayModifierDependency

void modifyArray (DependeeType newAmount, RCP< ParameterEntry > dependentToModify)
 
std::string getBadDependentValueErrorMessage () const
 

Additional Inherited Members

- Public Types inherited from Teuchos::Dependency
typedef std::set< RCP< ParameterEntry >, RCPCompParameterEntryList
 A list of Dependees.
 
typedef std::set< RCP< const ParameterEntry >, RCPConstCompConstParameterEntryList
 A list of dependents.
 
- Public Member Functions inherited from Teuchos::TwoDArrayModifierDependency< DependeeType, DependentType >
 TwoDArrayModifierDependency (RCP< const ParameterEntry > dependee, RCP< ParameterEntry > dependent, RCP< const SimpleFunctionObject< DependeeType > > func=null)
 Constructs a TwoDArrayModifierDependency.
 
 TwoDArrayModifierDependency (RCP< const ParameterEntry > dependee, Dependency::ParameterEntryList dependents, RCP< const SimpleFunctionObject< DependeeType > > func=null)
 Constructs a TwoDArrayModifierDependency.
 
- 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.
 
 ArrayModifierDependency (RCP< const ParameterEntry > dependee, ParameterEntryList dependents, RCP< const SimpleFunctionObject< DependeeType > > func=null)
 Constructs an ArrayModifierDependency.
 
RCP< const SimpleFunctionObject< DependeeType > > getFunctionObject () const
 Retrieves the function being used to calculate the amount by which an arrays dimensional attribute should be modified.
 
virtual void evaluate ()
 
- Public Member Functions inherited from Teuchos::Dependency
 Dependency (ConstParameterEntryList dependees, ParameterEntryList dependents)
 Constructs a Dependency.
 
 Dependency (ConstParameterEntryList dependees, RCP< ParameterEntry > dependent)
 Constructs a Dependency.
 
 Dependency (RCP< const ParameterEntry > dependee, ParameterEntryList dependents)
 Constructs a Dependency.
 
 Dependency (RCP< const ParameterEntry > dependee, RCP< ParameterEntry > dependent)
 Constructs a Dependency.
 
const ConstParameterEntryListgetDependees () const
 Gets the dependees of the dependency.
 
ParameterEntryListgetDependents ()
 Gets the dependents of the dependency.
 
const ConstParameterEntryListgetDependents () const
 Gets the dependents of the dependency.
 
RCP< const ParameterEntrygetFirstDependee () const
 Gets the first dependee in the dependees list. This is a convience function.
 
template<class S >
S getFirstDependeeValue () const
 Convienence function. Returns the first dependee in the list of dependees.
 
virtual void print (std::ostream &out) const
 prints out information about the dependency.
 
- Public Member Functions inherited from Teuchos::Describable
virtual std::string description () const
 Return a simple one-line description of this object.
 
virtual void describe (FancyOStream &out, const EVerbosityLevel verbLevel=verbLevel_default) const
 Print the object with some verbosity level to a FancyOStream.
 
void describe (std::ostream &out, const EVerbosityLevel verbLevel=verbLevel_default) const
 Version of describe() that takes an std::ostream instead of a FancyOStream.
 
virtual ~Describable ()
 Destructor (marked virtual for memory safety of derived classes).
 
- Public Member Functions inherited from Teuchos::LabeledObject
 LabeledObject ()
 Construct with an empty label.
 
virtual ~LabeledObject ()
 
virtual void setObjectLabel (const std::string &objectLabel)
 Set the object label (see LabeledObject).
 
virtual std::string getObjectLabel () const
 Get the object label (see LabeledObject).
 
- Static Public Member Functions inherited from Teuchos::Dependency
static const std::string & getXMLTagName ()
 Returns the XML tag to use when serializing Dependencies.
 
- Static Public Attributes inherited from Teuchos::Describable
static const EVerbosityLevel verbLevel_default = VERB_DEFAULT
 Default value for the verbLevel argument of describe().
 
- Protected Member Functions inherited from Teuchos::TwoDArrayModifierDependency< DependeeType, DependentType >
virtual void validateDep () const
 
- Protected Member Functions inherited from Teuchos::ArrayModifierDependency< DependeeType, DependentType >
- Protected Member Functions inherited from Teuchos::Dependency

Detailed Description

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

A dependency in which the number of rows in a parameter with a TwoDArray depends on the value of another parameter.

Please see TwoDColDependencyXMLConverter for documentation regarding the XML representation of this Dependency.

Definition at line 2087 of file Teuchos_StandardDependencies.hpp.

Constructor & Destructor Documentation

◆ TwoDColDependency() [1/2]

Constructs a TwoDColDependency.

Parameters
dependeeThe dependee parameter.
dependentThe dependent parameter.
funcA function specifying how the TwoDArrays number of cols should be calculated from the dependees value.

Definition at line 2149 of file Teuchos_StandardDependencies.hpp.

◆ TwoDColDependency() [2/2]

Constructs a TwoDColDependency.

Parameters
dependeeThe dependee parameter.
dependentsThe dependents.
funcA function specifying how the TwoDArrays number of cols should be calculated from the dependees value.

Definition at line 2160 of file Teuchos_StandardDependencies.hpp.

Member Function Documentation

◆ getTypeAttributeValue()

std::string Teuchos::TwoDColDependency< DependeeType, DependentType >::getTypeAttributeValue ( ) const
virtual

Implements Teuchos::Dependency.

Definition at line 2173 of file Teuchos_StandardDependencies.hpp.

◆ modifyArray()

void Teuchos::TwoDColDependency< DependeeType, DependentType >::modifyArray ( DependeeType newAmount,
RCP< ParameterEntry > dependentToModify )
protectedvirtual

◆ getBadDependentValueErrorMessage()

std::string Teuchos::TwoDColDependency< DependeeType, DependentType >::getBadDependentValueErrorMessage ( ) const
protectedvirtual

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