DOpE
Public Member Functions
DOpE::SimpleDirichletData< VECTOR, dealdim > Class Template Reference

#include <simpledirichletdata.h>

Inheritance diagram for DOpE::SimpleDirichletData< VECTOR, dealdim >:
DOpE::DirichletDataInterface< VECTOR, dealdim >

Public Member Functions

 SimpleDirichletData (const DOpEWrapper::Function< dealdim > &data)
 
double Data (const std::map< std::string, const dealii::Vector< double > * > *, const std::map< std::string, const VECTOR * > *, unsigned int, const dealii::Point< dealdim > &point, const unsigned int component) const
 
double Data_Q (const std::map< std::string, const dealii::Vector< double > * > *, const std::map< std::string, const VECTOR * > *, unsigned int, const dealii::Point< dealdim > &, const unsigned int) const
 
void SetTime (double time) const
 
unsigned int n_components () const
 
double InitialTime () const
 
- Public Member Functions inherited from DOpE::DirichletDataInterface< VECTOR, dealdim >
virtual void Data_QT (const std::map< std::string, const dealii::Vector< double > * > *, const std::map< std::string, const VECTOR * > *, unsigned int, const dealii::Point< dealdim > &, unsigned int, unsigned int, dealii::Vector< double > &) const
 
virtual void Data_QQT (const std::map< std::string, const dealii::Vector< double > * > *, const std::map< std::string, const VECTOR * > *, unsigned int, const dealii::Point< dealdim > &, unsigned int, unsigned int, dealii::Vector< double > &) const
 
virtual bool NeedsControl () const
 

Detailed Description

template<typename VECTOR, int dealdim>
class DOpE::SimpleDirichletData< VECTOR, dealdim >

A Simple Interface Class, that sets DirichletData given by a DOpEWrapper::Function. This means they don't depend on control or state values

Constructor & Destructor Documentation

template<typename VECTOR , int dealdim>
DOpE::SimpleDirichletData< VECTOR, dealdim >::SimpleDirichletData ( const DOpEWrapper::Function< dealdim > &  data)
inline

Member Function Documentation

template<typename VECTOR , int dealdim>
double DOpE::SimpleDirichletData< VECTOR, dealdim >::Data ( const std::map< std::string, const dealii::Vector< double > * > *  ,
const std::map< std::string, const VECTOR * > *  ,
unsigned  int,
const dealii::Point< dealdim > &  ,
const unsigned int  int 
) const
inlinevirtual

This Function should return the dirichlet value in the component component at the given point

Parameters
control_dof_handlerThe DOpEWrapper::DoFHandler for the control variable
state_dof_handlerThe DOpEWrapper::DoFHandler for the state variable
param_valuesA std::map containing parameter data (e.g. non space dependent data). If the control is done by parameters, it is contained in this map at the position "control".
domain_valuesA std::map containing domain data (e.g. nodal vectors for FE-Functions). If the control is distributed, it is contained in this map at the position "control". WARNING! never use the value "last_newton_solution" in this map!
colorA color indicating the boundary at which we are
pointThe point at which we would like to evaluate the dirichlet data.
componentAn unsigned integer indicating the component we would like to use.
Returns
The dirichletdata for the componten at point.

Implements DOpE::DirichletDataInterface< VECTOR, dealdim >.

template<typename VECTOR , int dealdim>
double DOpE::SimpleDirichletData< VECTOR, dealdim >::Data_Q ( const std::map< std::string, const dealii::Vector< double > * > *  ,
const std::map< std::string, const VECTOR * > *  ,
unsigned  int,
const dealii::Point< dealdim > &  ,
const unsigned  int 
) const
inlinevirtual

This Function should return the derivative wrt. the control of the dirichlet value at the in the component component at the given point. The point at which the derivative should be evaluated is called "control" and the direction "dq" in the corresponding map.

Parameters
control_dof_handlerThe DOpEWrapper::DoFHandler for the control variable
state_dof_handlerThe DOpEWrapper::DoFHandler for the state variable
param_valuesA std::map containing parameter data (e.g. non space dependent data). If the control is done by parameters, it is contained in this map at the position "control".
domain_valuesA std::map containing domain data (e.g. nodal vectors for FE-Functions). If the control is distributed, it is contained in this map at the position "control". WARNING! never use the value "last_newton_solution" in this map!
colorA color indicating the boundary at which we are
pointThe point at which we would like to evaluate the dirichlet data.
componentAn unsigned integer indicating the component we would like to use.
Returns
The dirichletdata for the componten at point.

Implements DOpE::DirichletDataInterface< VECTOR, dealdim >.

template<typename VECTOR , int dealdim>
double DOpE::SimpleDirichletData< VECTOR, dealdim >::InitialTime ( ) const
inlinevirtual

Returns the Initial Time used for all derived DOpEWrapper::Function objects

Reimplemented from DOpE::DirichletDataInterface< VECTOR, dealdim >.

template<typename VECTOR , int dealdim>
unsigned int DOpE::SimpleDirichletData< VECTOR, dealdim >::n_components ( ) const
inlinevirtual

Returns the number of components used for all derived DOpEWrapper::Function objects

Reimplemented from DOpE::DirichletDataInterface< VECTOR, dealdim >.

template<typename VECTOR , int dealdim>
void DOpE::SimpleDirichletData< VECTOR, dealdim >::SetTime ( double  ) const
inlinevirtual

This Function is used to transfer the current time to the dirichlet data if needed this should be stored.

Parameters
timeThe current time

Reimplemented from DOpE::DirichletDataInterface< VECTOR, dealdim >.


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