Panzer Version of the Day
Loading...
Searching...
No Matches
Classes | Public Member Functions | Protected Types | Protected Member Functions | Protected Attributes | List of all members
panzer::BCStrategy_Dirichlet_DefaultImpl< EvalT > Class Template Referenceabstract

#include <Panzer_BCStrategy_Dirichlet_DefaultImpl.hpp>

Inheritance diagram for panzer::BCStrategy_Dirichlet_DefaultImpl< EvalT >:
Inheritance graph
[legend]

Classes

struct  DOFDescriptor
 

Public Member Functions

 BCStrategy_Dirichlet_DefaultImpl (const panzer::BC &bc, const Teuchos::RCP< panzer::GlobalData > &global_data, const bool check_apply_bc=false)
 
virtual ~BCStrategy_Dirichlet_DefaultImpl ()
 
virtual void setup (const panzer::PhysicsBlock &side_pb, const Teuchos::ParameterList &user_data)=0
 
virtual void buildAndRegisterEvaluators (PHX::FieldManager< panzer::Traits > &fm, const panzer::PhysicsBlock &pb, const panzer::ClosureModelFactory_TemplateManager< panzer::Traits > &factory, const Teuchos::ParameterList &models, const Teuchos::ParameterList &user_data) const =0
 
virtual void buildAndRegisterGatherScatterEvaluators (PHX::FieldManager< panzer::Traits > &fm, const panzer::PhysicsBlock &pb, const panzer::LinearObjFactory< panzer::Traits > &lof, const Teuchos::ParameterList &user_data) const
 
virtual void buildAndRegisterScatterEvaluators (PHX::FieldManager< panzer::Traits > &fm, const panzer::PhysicsBlock &side_pb, const LinearObjFactory< panzer::Traits > &lof, const Teuchos::ParameterList &user_data) const
 
virtual void buildAndRegisterGatherAndOrientationEvaluators (PHX::FieldManager< panzer::Traits > &fm, const panzer::PhysicsBlock &side_pb, const LinearObjFactory< panzer::Traits > &lof, const Teuchos::ParameterList &user_data) const
 
- Public Member Functions inherited from panzer::BCStrategy< EvalT >
 BCStrategy (const panzer::BC &bc)
 
virtual ~BCStrategy ()
 
- Public Member Functions inherited from panzer::BCStrategyBase
 BCStrategyBase ()
 
virtual ~BCStrategyBase ()
 
- Public Member Functions inherited from panzer::EvaluatorsRegistrar
int setDetailsIndex (const int details_index)
 
int getDetailsIndex () const
 Get the WorksetDetails index.
 
- Public Member Functions inherited from panzer::GlobalDataAcceptorDefaultImpl
 GlobalDataAcceptorDefaultImpl ()
 
 GlobalDataAcceptorDefaultImpl (const Teuchos::RCP< panzer::GlobalData > &gd)
 
 ~GlobalDataAcceptorDefaultImpl ()
 
void setGlobalData (const Teuchos::RCP< panzer::GlobalData > &gd)
 
Teuchos::RCP< panzer::GlobalData > getGlobalData () const
 
- Public Member Functions inherited from panzer::GlobalDataAcceptor
virtual ~GlobalDataAcceptor ()
 

Protected Types

typedef std::map< std::string, DOFDescriptor >::const_iterator DescriptorIterator
 For convenience, declare the DOFDescriptor iterator.
 

Protected Member Functions

void buildDescriptorMapFromVectors () const
 
void addDOF (const std::string &dofName)
 
void addCoefficientTarget (const std::string &targetName, const std::string &dofName, const std::string &residualName="")
 
void addTarget (const std::string &targetName, const std::string &dofName, const std::string &residualName="")
 
void addDotTarget (const std::string &targetName, const std::string &dofName, const std::string &dotName="", const std::string &residualName="")
 
- Protected Member Functions inherited from panzer::EvaluatorsRegistrar
 EvaluatorsRegistrar ()
 Default ctor initializes WorksetDetails index to 0.
 
virtual ~EvaluatorsRegistrar ()
 
template<typename EvalT >
void registerEvaluator (PHX::FieldManager< panzer::Traits > &fm, const Teuchos::RCP< PHX::Evaluator< panzer::Traits > > &op) const
 

Protected Attributes

std::map< std::string, DOFDescriptor > m_provided_dofs_desc
 
std::vector< std::string > required_dof_names
 
std::map< std::string, std::string > residual_to_dof_names_map
 
std::map< std::string, std::string > residual_to_target_field_map
 
bool check_apply_bc
 
bool descriptor_map_built
 
- Protected Attributes inherited from panzer::BCStrategy< EvalT >
const panzer::BC m_bc
 

Detailed Description

template<typename EvalT>
class panzer::BCStrategy_Dirichlet_DefaultImpl< EvalT >

Definition at line 29 of file Panzer_BCStrategy_Dirichlet_DefaultImpl.hpp.

Member Typedef Documentation

◆ DescriptorIterator

template<typename EvalT >
typedef std::map<std::string,DOFDescriptor>::const_iterator panzer::BCStrategy_Dirichlet_DefaultImpl< EvalT >::DescriptorIterator
protected

For convenience, declare the DOFDescriptor iterator.

Definition at line 101 of file Panzer_BCStrategy_Dirichlet_DefaultImpl.hpp.

Constructor & Destructor Documentation

◆ BCStrategy_Dirichlet_DefaultImpl()

template<typename EvalT >
panzer::BCStrategy_Dirichlet_DefaultImpl< EvalT >::BCStrategy_Dirichlet_DefaultImpl ( const panzer::BC &  bc,
const Teuchos::RCP< panzer::GlobalData > &  global_data,
const bool  check_apply_bc = false 
)

Definition at line 45 of file Panzer_BCStrategy_Dirichlet_DefaultImpl_impl.hpp.

◆ ~BCStrategy_Dirichlet_DefaultImpl()

template<typename EvalT >
panzer::BCStrategy_Dirichlet_DefaultImpl< EvalT >::~BCStrategy_Dirichlet_DefaultImpl ( )
virtual

Definition at line 59 of file Panzer_BCStrategy_Dirichlet_DefaultImpl_impl.hpp.

Member Function Documentation

◆ setup()

template<typename EvalT >
virtual void panzer::BCStrategy_Dirichlet_DefaultImpl< EvalT >::setup ( const panzer::PhysicsBlock &  side_pb,
const Teuchos::ParameterList &  user_data 
)
pure virtual

Must be called before this->buildAndRegisterEvaluators() and this->buildAndRegisterGatherScatterEvaluators().

Implements panzer::BCStrategy< EvalT >.

◆ buildAndRegisterEvaluators()

template<typename EvalT >
virtual void panzer::BCStrategy_Dirichlet_DefaultImpl< EvalT >::buildAndRegisterEvaluators ( PHX::FieldManager< panzer::Traits > &  fm,
const panzer::PhysicsBlock &  pb,
const panzer::ClosureModelFactory_TemplateManager< panzer::Traits > &  factory,
const Teuchos::ParameterList &  models,
const Teuchos::ParameterList &  user_data 
) const
pure virtual

Implements panzer::BCStrategy< EvalT >.

◆ buildAndRegisterGatherScatterEvaluators()

template<typename EvalT >
void panzer::BCStrategy_Dirichlet_DefaultImpl< EvalT >::buildAndRegisterGatherScatterEvaluators ( PHX::FieldManager< panzer::Traits > &  fm,
const panzer::PhysicsBlock &  pb,
const panzer::LinearObjFactory< panzer::Traits > &  lof,
const Teuchos::ParameterList &  user_data 
) const
virtual

Definition at line 67 of file Panzer_BCStrategy_Dirichlet_DefaultImpl_impl.hpp.

◆ buildAndRegisterScatterEvaluators()

template<typename EvalT >
void panzer::BCStrategy_Dirichlet_DefaultImpl< EvalT >::buildAndRegisterScatterEvaluators ( PHX::FieldManager< panzer::Traits > &  fm,
const panzer::PhysicsBlock &  side_pb,
const LinearObjFactory< panzer::Traits > &  lof,
const Teuchos::ParameterList &  user_data 
) const
virtual

Implements panzer::BCStrategy< EvalT >.

Definition at line 83 of file Panzer_BCStrategy_Dirichlet_DefaultImpl_impl.hpp.

◆ buildAndRegisterGatherAndOrientationEvaluators()

template<typename EvalT >
void panzer::BCStrategy_Dirichlet_DefaultImpl< EvalT >::buildAndRegisterGatherAndOrientationEvaluators ( PHX::FieldManager< panzer::Traits > &  fm,
const panzer::PhysicsBlock &  side_pb,
const LinearObjFactory< panzer::Traits > &  lof,
const Teuchos::ParameterList &  user_data 
) const
virtual

Implements panzer::BCStrategy< EvalT >.

Definition at line 174 of file Panzer_BCStrategy_Dirichlet_DefaultImpl_impl.hpp.

◆ buildDescriptorMapFromVectors()

template<typename EvalT >
void panzer::BCStrategy_Dirichlet_DefaultImpl< EvalT >::buildDescriptorMapFromVectors ( ) const
protected

This is to support backward compatibility and allow a migration path from the old protected data approach of specifying the inputs and outputs of this class.

Definition at line 381 of file Panzer_BCStrategy_Dirichlet_DefaultImpl_impl.hpp.

◆ addDOF()

template<typename EvalT >
void panzer::BCStrategy_Dirichlet_DefaultImpl< EvalT >::addDOF ( const std::string &  dofName)
protected

Definition at line 420 of file Panzer_BCStrategy_Dirichlet_DefaultImpl_impl.hpp.

◆ addCoefficientTarget()

template<typename EvalT >
void panzer::BCStrategy_Dirichlet_DefaultImpl< EvalT >::addCoefficientTarget ( const std::string &  targetName,
const std::string &  dofName,
const std::string &  residualName = "" 
)
protected

Alert the panzer library that the DOF should be evaluated using a coefficient residual as opposed to evaluating the basis and forcing the value to be equal at some point in the element.

Parameters
[in]targetName(Required) Name of field that corresponds to the evaluated dirichlet condition. This exists only in the PHX::FieldManager and is required to be distinct from the dofName.
[in]dofName(Required) Name of field to lookup in the unique global indexer. The
[in]residualName(Optional) Name of field that is to be scattered associated with this DOF. If not supplied or an empty string used, the default is to add the prefix "RESIDUAL_" to the dofName for the residual field name.

Definition at line 450 of file Panzer_BCStrategy_Dirichlet_DefaultImpl_impl.hpp.

◆ addTarget()

template<typename EvalT >
void panzer::BCStrategy_Dirichlet_DefaultImpl< EvalT >::addTarget ( const std::string &  targetName,
const std::string &  dofName,
const std::string &  residualName = "" 
)
protected

Alert the panzer library of a DOF that is required by this boundary condition. This automatically sets up the gather/scatter routines neccessary to evaluate and assemble with this unknown.

Parameters
[in]targetName(Required) Name of field that corresponds to the evaluated dirichlet condition. This exists only in the PHX::FieldManager and is required to be distinct from the dofName.
[in]dofName(Required) Name of field to lookup in the unique global indexer. The
[in]residualName(Optional) Name of field that is to be scattered associated with this DOF. If not supplied or an empty string used, the default is to add the prefix "RESIDUAL_" to the dofName for the residual field name.

Definition at line 433 of file Panzer_BCStrategy_Dirichlet_DefaultImpl_impl.hpp.

◆ addDotTarget()

template<typename EvalT >
void panzer::BCStrategy_Dirichlet_DefaultImpl< EvalT >::addDotTarget ( const std::string &  targetName,
const std::string &  dofName,
const std::string &  dotName = "",
const std::string &  residualName = "" 
)
protected

Alert the panzer library that the time derivative of a DOF is required by this boundary condition. This automatically sets up the gather/scatter routines neccessary to evaluate and assemble with this unknown.

Parameters
[in]targetName(Required) Name of field that corresponds to the evaluated dirichlet condition. This exists only in the PHX::FieldManager and is required to be distinct from the dofName.
[in]dofName(Required) Name of field to lookup in the unique global indexer. The
[in]residualName(Optional) Name of field that is to be scattered associated with this DOF. If not supplied or an empty string used, the default is to add the prefix "RESIDUAL_" to the dofName for the residual field name.

Definition at line 469 of file Panzer_BCStrategy_Dirichlet_DefaultImpl_impl.hpp.

Member Data Documentation

◆ m_provided_dofs_desc

template<typename EvalT >
std::map<std::string,DOFDescriptor> panzer::BCStrategy_Dirichlet_DefaultImpl< EvalT >::m_provided_dofs_desc
protected

Definition at line 160 of file Panzer_BCStrategy_Dirichlet_DefaultImpl.hpp.

◆ required_dof_names

template<typename EvalT >
std::vector<std::string> panzer::BCStrategy_Dirichlet_DefaultImpl< EvalT >::required_dof_names
protected

Definition at line 162 of file Panzer_BCStrategy_Dirichlet_DefaultImpl.hpp.

◆ residual_to_dof_names_map

template<typename EvalT >
std::map<std::string,std::string> panzer::BCStrategy_Dirichlet_DefaultImpl< EvalT >::residual_to_dof_names_map
protected

Definition at line 163 of file Panzer_BCStrategy_Dirichlet_DefaultImpl.hpp.

◆ residual_to_target_field_map

template<typename EvalT >
std::map<std::string,std::string> panzer::BCStrategy_Dirichlet_DefaultImpl< EvalT >::residual_to_target_field_map
protected

Definition at line 164 of file Panzer_BCStrategy_Dirichlet_DefaultImpl.hpp.

◆ check_apply_bc

template<typename EvalT >
bool panzer::BCStrategy_Dirichlet_DefaultImpl< EvalT >::check_apply_bc
protected

Definition at line 165 of file Panzer_BCStrategy_Dirichlet_DefaultImpl.hpp.

◆ descriptor_map_built

template<typename EvalT >
bool panzer::BCStrategy_Dirichlet_DefaultImpl< EvalT >::descriptor_map_built
mutableprotected

Definition at line 166 of file Panzer_BCStrategy_Dirichlet_DefaultImpl.hpp.

The documentation for this class was generated from the following files:
Generated by doxygen 1.9.8