DOpE
Public Member Functions
DOpE::DirichletDataInterface< VECTOR, dealdim > Class Template Referenceabstract

#include <dirichletdatainterface.h>

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

Public Member Functions

virtual double Data (const std::map< std::string, const dealii::Vector< double > * > *, const std::map< std::string, const VECTOR * > *, unsigned int, const dealii::Point< dealdim > &, unsigned int) const =0
 
virtual 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 > &, unsigned int) const =0
 
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 void SetTime (double) const
 
virtual unsigned int n_components () const
 
virtual double InitialTime () const
 
virtual bool NeedsControl () const
 

Detailed Description

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

Interface for DirichletData

Member Function Documentation

template<typename VECTOR , int dealdim>
virtual double DOpE::DirichletDataInterface< 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 > &  ,
unsigned  int 
) const
pure virtual

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.

Implemented in DOpE::SimpleDirichletData< VECTOR, dealdim >.

template<typename VECTOR , int dealdim>
virtual double DOpE::DirichletDataInterface< 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 > &  ,
unsigned  int 
) const
pure virtual

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.

Implemented in DOpE::SimpleDirichletData< VECTOR, dealdim >.

template<typename VECTOR , int dealdim>
virtual void DOpE::DirichletDataInterface< VECTOR, dealdim >::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
inlinevirtual

This Function should return the transposed second derivative wrt. the control of the dirichlet value. The output should be ordered by components in the control. The Testfunction is given in the domain_values map with the name "hessian_residual". The second testfunction is in the control space and denoted by "dq"

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.
dof_numberThe number of the dof with support on the given point.
local_vectorThe transposed dirichlet data at the point
template<typename VECTOR , int dealdim>
virtual void DOpE::DirichletDataInterface< VECTOR, dealdim >::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
inlinevirtual

This Function should return the transposed derivative wrt. the control of the dirichlet value. The output should be ordered by components in the control. The Testfunction is given in the domain_values map with the name "adjoint_residual"

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.
dof_numberThe number of the dof with support on the given point.
local_vectorThe transposed dirichlet data at the point
template<typename VECTOR , int dealdim>
virtual double DOpE::DirichletDataInterface< VECTOR, dealdim >::InitialTime ( ) const
inlinevirtual

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

Reimplemented in DOpE::SimpleDirichletData< VECTOR, dealdim >.

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

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

Reimplemented in DOpE::SimpleDirichletData< VECTOR, dealdim >.

template<typename VECTOR , int dealdim>
virtual bool DOpE::DirichletDataInterface< VECTOR, dealdim >::NeedsControl ( ) const
inlinevirtual

This Function must return true if the DirichletData depend on the Control. Otherwise Gradient evaluation will fail.

template<typename VECTOR , int dealdim>
virtual void DOpE::DirichletDataInterface< 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 in DOpE::SimpleDirichletData< VECTOR, dealdim >.


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