Multidisciplinary-design Adaptation and Sensitivity Toolkit (MAST)
MAST::Parameter Class Reference

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.

#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 ()
virtual bool depends_on (const MAST::FunctionBase &f) const
Realoperator() ()
Real operator() () const
void operator= (const Real &val)
 sets the value of this function More...
Realptr ()
- 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...
virtual bool is_shape_parameter () const
virtual bool is_topology_parameter () const
const std::string & name () const
 returns the name of this function More...
virtual void set_as_shape_parameter (bool f)
virtual void set_as_topology_parameter (bool f)

Protected Attributes

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

Constructor & Destructor Documentation

◆ Parameter() [1/2]

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

Definition at line 40 of file parameter.h.

◆ Parameter() [2/2]

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

Definition at line 47 of file parameter.h.

◆ ~Parameter()

virtual MAST::Parameter::~Parameter ( )

Definition at line 53 of file parameter.h.

Member Function Documentation

◆ depends_on()

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

Reimplemented from MAST::FunctionBase.

Definition at line 86 of file parameter.h.

◆ operator()() [1/2]

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

Definition at line 62 of file parameter.h.

◆ operator()() [2/2]

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

Definition at line 70 of file parameter.h.

◆ operator=()

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

sets the value of this function

Definition at line 98 of file parameter.h.

◆ ptr()

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

Definition at line 78 of file parameter.h.

Member Data Documentation

◆ _val

Real* MAST::Parameter::_val

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: