GRINS::AdjointErrorEstimatorFactoryBase< EstimatorType > Class Template Reference

#include <adjoint_error_estimator_factories.h>

Inheritance diagram for GRINS::AdjointErrorEstimatorFactoryBase< EstimatorType >:

Collaboration diagram for GRINS::AdjointErrorEstimatorFactoryBase< EstimatorType >:

Public Member Functions
	AdjointErrorEstimatorFactoryBase (const std::string &estimator_name)
	~AdjointErrorEstimatorFactoryBase ()
Public Member Functions inherited from GRINS::ErrorEstimatorFactoryBase
	ErrorEstimatorFactoryBase (const std::string &estimator_name)
	~ErrorEstimatorFactoryBase ()
Public Member Functions inherited from GRINS::FactoryWithGetPot< libMesh::ErrorEstimator >
	FactoryWithGetPot (const std::string &name)
	~FactoryWithGetPot ()
Public Member Functions inherited from GRINS::FactoryAbstract< libMesh::ErrorEstimator >
virtual	~FactoryAbstract ()

Protected Member Functions
virtual libMesh::UniquePtr< libMesh::ErrorEstimator >	build_error_estimator (const GetPot &input, MultiphysicsSystem &system, const ErrorEstimatorOptions &estimator_options)
	Subclasses implement this method for building the ErrorEstimator object. More...
virtual void	set_adjoint_estimator_options (const GetPot &input, const ErrorEstimatorOptions &estimator_options, EstimatorType &estimator)=0
Protected Member Functions inherited from GRINS::FactoryAbstract< libMesh::ErrorEstimator >
	FactoryAbstract (const std::string &name)
	Constructor is protected. Use the build() method to construct Base objects. More...

Additional Inherited Members
Static Public Member Functions inherited from GRINS::ErrorEstimatorFactoryBase
static void	set_system (MultiphysicsSystem &system)
static void	set_estimator_options (const ErrorEstimatorOptions &estimator_options)
Static Public Member Functions inherited from GRINS::FactoryWithGetPot< libMesh::ErrorEstimator >
static void	set_getpot (const GetPot &input)
Static Public Member Functions inherited from GRINS::FactoryAbstract< libMesh::ErrorEstimator >
static libMesh::UniquePtr< libMesh::ErrorEstimator >	build (const std::string &name)
	Use this method to build objects of type Base. More...
Static Protected Member Functions inherited from GRINS::FactoryAbstract< libMesh::ErrorEstimator >
static FactoryAbstract< libMesh::ErrorEstimator > &	get_factory (const std::string &name)
	Helper method that looks up the factory and returns it if present, or error if it's not. More...
static DerivedType &	get_factory_subclass (const std::string &name)
	Like get_factory, but will downcast to DerivedType. More...
static std::map< std::string, FactoryAbstract< libMesh::ErrorEstimator > * > &	factory_map ()
Static Protected Attributes inherited from GRINS::ErrorEstimatorFactoryBase
static MultiphysicsSystem *	_system = NULL
	Cache pointer to system. More...
static const ErrorEstimatorOptions *	_estimator_options = NULL
	Cache pointer to system. More...
Static Protected Attributes inherited from GRINS::FactoryWithGetPot< libMesh::ErrorEstimator >
static const GetPot *	_input
	We store only a raw pointer here because we can't make a copy. More...

Detailed Description

template<typename EstimatorType>
class GRINS::AdjointErrorEstimatorFactoryBase< EstimatorType >

Definition at line 39 of file adjoint_error_estimator_factories.h.

Constructor & Destructor Documentation

template<typename EstimatorType>

GRINS::AdjointErrorEstimatorFactoryBase< EstimatorType >::AdjointErrorEstimatorFactoryBase ( const std::string &  estimator_name )

inline

Definition at line 42 of file adjoint_error_estimator_factories.h.

      : ErrorEstimatorFactoryBase(estimator_name)
    {}

template<typename EstimatorType>

GRINS::AdjointErrorEstimatorFactoryBase< EstimatorType >::~AdjointErrorEstimatorFactoryBase ( )

inline

Definition at line 46 of file adjoint_error_estimator_factories.h.

{};

Member Function Documentation

template<typename EstimatorType>

virtual libMesh::UniquePtr<libMesh::ErrorEstimator> GRINS::AdjointErrorEstimatorFactoryBase< EstimatorType >::build_error_estimator ( const GetPot &  input, MultiphysicsSystem &  system, const ErrorEstimatorOptions &  estimator_options  )

inlineprotectedvirtual

Subclasses implement this method for building the ErrorEstimator object.

Implements GRINS::ErrorEstimatorFactoryBase.

Definition at line 51 of file adjoint_error_estimator_factories.h.

    {
      libMesh::UniquePtr<libMesh::ErrorEstimator>
        raw_error_estimator( new EstimatorType );

      // Now cast to derived type
      EstimatorType* adjoint_error_estimator =
        libMesh::cast_ptr<EstimatorType*>(raw_error_estimator.get() );

      // Set a QoISet
      libMesh::QoISet qoi_set(system);
      adjoint_error_estimator->qoi_set() = qoi_set;

      // Now set the options for the derived type
      this->set_adjoint_estimator_options( input, estimator_options, *adjoint_error_estimator );

      return raw_error_estimator;
    }

template<typename EstimatorType>

virtual void GRINS::AdjointErrorEstimatorFactoryBase< EstimatorType >::set_adjoint_estimator_options ( const GetPot &  input, const ErrorEstimatorOptions &  estimator_options, EstimatorType &  estimator  )

protectedpure virtual

Implemented in GRINS::AdjointRefinementErrorEstimatorFactory, and GRINS::AdjointResidualErrorEstimatorFactory.

Referenced by GRINS::AdjointErrorEstimatorFactoryBase< libMesh::AdjointResidualErrorEstimator >::build_error_estimator().

---

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

• src/strategies/include/grins/adjoint_error_estimator_factories.h