MAST
MAST::Parameter Class Reference

This is a scalar function whose value can be changed and one that can be used as a design variable in sensitivity analysis and optimization across the code. More...

#include <parameter.h>

Inheritance diagram for MAST::Parameter:
Collaboration diagram for MAST::Parameter:

Public Member Functions

 Parameter (const std::string &nm, const Real &val)
 
 Parameter (const MAST::Parameter &f)
 
virtual ~Parameter ()
 
Realoperator() ()
 
Real operator() () const
 
Realptr ()
 
virtual bool depends_on (const MAST::FunctionBase &f) const
 
void operator= (const Real &val)
 sets the value of this function More...
 
- Public Member Functions inherited from MAST::FunctionBase
 FunctionBase (const std::string &nm, const bool is_field_func)
 initializes the parameter to the given name More...
 
 FunctionBase (const MAST::FunctionBase &f)
 Copy constructor. More...
 
virtual ~FunctionBase ()
 virtual destructor More...
 
const std::string & name () const
 returns the name of this function More...
 
virtual bool is_shape_parameter () const
 
virtual void set_as_shape_parameter (bool f)
 
virtual bool is_topology_parameter () const
 
virtual void set_as_topology_parameter (bool f)
 

Protected Attributes

Real_val
 Pointer to the value of the parameter. More...
 
- Protected Attributes inherited from MAST::FunctionBase
std::string _name
 name of this parameter More...
 
bool _is_field_func
 flag to store the nature of field function More...
 
bool _is_shape_parameter
 
bool _is_topology_parameter
 
std::set< const MAST::FunctionBase * > _functions
 set of functions that this function depends on More...
 

Detailed Description

This is a scalar function whose value can be changed and one that can be used as a design variable in sensitivity analysis and optimization across the code.

Definition at line 35 of file parameter.h.

Constructor & Destructor Documentation

MAST::Parameter::Parameter ( const std::string &  nm,
const Real val 
)
inline

Definition at line 40 of file parameter.h.

MAST::Parameter::Parameter ( const MAST::Parameter f)
inline

Definition at line 47 of file parameter.h.

virtual MAST::Parameter::~Parameter ( )
inlinevirtual

Definition at line 53 of file parameter.h.

Member Function Documentation

virtual bool MAST::Parameter::depends_on ( const MAST::FunctionBase f) const
inlinevirtual
Returns
true only if the given function is this.

Reimplemented from MAST::FunctionBase.

Definition at line 86 of file parameter.h.

Here is the caller graph for this function:

Real& MAST::Parameter::operator() ( )
inline
Returns
a writable reference to this parameter value

Definition at line 62 of file parameter.h.

Real MAST::Parameter::operator() ( ) const
inline
Returns
the parameter value

Definition at line 70 of file parameter.h.

void MAST::Parameter::operator= ( const Real val)
inline

sets the value of this function

Definition at line 98 of file parameter.h.

Real* MAST::Parameter::ptr ( )
inline
Returns
the pointer to value of this function.

Definition at line 78 of file parameter.h.

Member Data Documentation

Real* MAST::Parameter::_val
protected

Pointer to the value of the parameter.

Definition at line 107 of file parameter.h.


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