MAST::Optimization::DesignParameter< ScalarType > Class Template Reference

Detailed Description

template<typename ScalarType>
class MAST::Optimization::DesignParameter< ScalarType >

Definition at line 30 of file design_parameter.hpp.

#include <design_parameter.hpp>

Inheritance diagram for MAST::Optimization::DesignParameter< ScalarType >:

Collaboration diagram for MAST::Optimization::DesignParameter< ScalarType >:

Public Types
using	scalar_t = ScalarType
Public Types inherited from MAST::Base::ScalarConstant< ScalarType >
using	scalar_t = ScalarType

Public Member Functions
	DesignParameter (ScalarType v=0.)
virtual	~DesignParameter ()
uint_t	id () const
const Eigen::Matrix< real_t, 3, 1 > &	point () const
void	set_id (uint_t i)
void	set_point (real_t x, real_t y=0., real_t z=0.)
Public Member Functions inherited from MAST::Base::ScalarConstant< ScalarType >
	ScalarConstant (ScalarType v=0.)
virtual	~ScalarConstant ()
template<typename ContextType , typename ScalarFieldType >
ScalarType	derivative (ContextType &c, const ScalarFieldType &f) const
template<typename ContextType , typename ScalarFieldType >
void	derivative (ContextType &c, const ScalarFieldType &f, ScalarType &v) const
ScalarType &	operator() ()
ScalarType	operator() () const
ScalarType &	operator= (const ScalarType &v)
template<typename ContextType >
ScalarType	value (ContextType &c) const
template<typename ContextType >
void	value (ContextType &c, ScalarType &v) const

Private Attributes
uint_t	_id
Eigen::Matrix< real_t, 3, 1 >	_point
	point to which this parameter is attached More...

Member Typedef Documentation

scalar_t

template<typename ScalarType>

using MAST::Optimization::DesignParameter< ScalarType >::scalar_t = ScalarType

Definition at line 34 of file design_parameter.hpp.

Constructor & Destructor Documentation

DesignParameter()

template<typename ScalarType>

MAST::Optimization::DesignParameter< ScalarType >::DesignParameter ( ScalarType  v = 0. )

inline

Definition at line 36 of file design_parameter.hpp.

                                      :
    MAST::Base::ScalarConstant<ScalarType>  (v),
    _id    (-1) {

        _point.setZero();
    }

~DesignParameter()

template<typename ScalarType>

virtual MAST::Optimization::DesignParameter< ScalarType >::~DesignParameter ( )

inlinevirtual

Definition at line 43 of file design_parameter.hpp.

{ }

Member Function Documentation

id()

template<typename ScalarType>

uint_t MAST::Optimization::DesignParameter< ScalarType >::id ( ) const

inline

Definition at line 47 of file design_parameter.hpp.

{ return _id;}

point()

template<typename ScalarType>

const Eigen::Matrix<real_t, 3, 1>& MAST::Optimization::DesignParameter< ScalarType >::point ( ) const

inline

Definition at line 58 of file design_parameter.hpp.

{ return _point;}

set_id()

template<typename ScalarType>

void MAST::Optimization::DesignParameter< ScalarType >::set_id ( uint_t  i )

inline

Definition at line 45 of file design_parameter.hpp.

{ _id = i;}

set_point()

template<typename ScalarType>

void MAST::Optimization::DesignParameter< ScalarType >::set_point ( real_t  x, real_t  y = 0., real_t  z = 0.  )

inline

Definition at line 49 of file design_parameter.hpp.

                                             {
        
        _point(0) = x;
        _point(1) = y;
        _point(2) = z;
    }

Member Data Documentation

_id

template<typename ScalarType>

uint_t MAST::Optimization::DesignParameter< ScalarType >::_id

private

Definition at line 63 of file design_parameter.hpp.

_point

template<typename ScalarType>

Eigen::Matrix<real_t, 3, 1> MAST::Optimization::DesignParameter< ScalarType >::_point

private

point to which this parameter is attached

Definition at line 66 of file design_parameter.hpp.

---

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

• /home/travis/build/MASTmultiphysics/MAST3/include/mast/optimization/design_parameter.hpp