GRINS::PhysicsFactoryBase Class Reference

Builds Physics objects, used by PhysicsBuilder. More...

#include <physics_factory_base.h>

Inheritance diagram for GRINS::PhysicsFactoryBase:

Collaboration diagram for GRINS::PhysicsFactoryBase:

Public Member Functions
	PhysicsFactoryBase (const std::string &physics_name)
	~PhysicsFactoryBase ()
Public Member Functions inherited from GRINS::FactoryWithGetPotPhysicsName< Physics >
	FactoryWithGetPotPhysicsName (const std::string &name)
	~FactoryWithGetPotPhysicsName ()
Public Member Functions inherited from GRINS::FactoryWithGetPot< Physics >
	FactoryWithGetPot (const std::string &name)
	~FactoryWithGetPot ()
Public Member Functions inherited from GRINS::FactoryAbstract< Physics >
virtual	~FactoryAbstract ()

Protected Member Functions
virtual libMesh::UniquePtr< Physics >	build_physics (const GetPot &input, const std::string &physics_name)=0
Protected Member Functions inherited from GRINS::FactoryAbstract< Physics >
	FactoryAbstract (const std::string &name)
	Constructor is protected. Use the build() method to construct Base objects. More...

Private Member Functions
virtual libMesh::UniquePtr< Physics >	create ()
	Subclasses implement the actual construction of the Base object in create(). More...

Additional Inherited Members
Static Public Member Functions inherited from GRINS::FactoryWithGetPotPhysicsName< Physics >
static void	set_physics_name (const std::string &physics_name)
	Setter for physics name. More...
Static Public Member Functions inherited from GRINS::FactoryWithGetPot< Physics >
static void	set_getpot (const GetPot &input)
Static Public Member Functions inherited from GRINS::FactoryAbstract< Physics >
static libMesh::UniquePtr< Physics >	build (const std::string &name)
	Use this method to build objects of type Base. More...
Static Protected Member Functions inherited from GRINS::FactoryAbstract< Physics >
static FactoryAbstract< Physics > &	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< Physics > * > &	factory_map ()
Static Protected Attributes inherited from GRINS::FactoryWithGetPotPhysicsName< Physics >
static std::string	_physics_name
Static Protected Attributes inherited from GRINS::FactoryWithGetPot< Physics >
static const GetPot *	_input
	We store only a raw pointer here because we can't make a copy. More...

Detailed Description

Builds Physics objects, used by PhysicsBuilder.

The user may subclass this class for more building more complex Physics objects. Because Physics objects require a GetPot input file object and the physics_name at construction time, both set_getpot() and set_physics_name() MUST be called before build() function. Note that set_physics_name() MUST be called each time a new Physics is built.

Definition at line 45 of file physics_factory_base.h.

Constructor & Destructor Documentation

GRINS::PhysicsFactoryBase::PhysicsFactoryBase ( const std::string &  physics_name )

inline

Definition at line 48 of file physics_factory_base.h.

      : FactoryWithGetPotPhysicsName<Physics>(physics_name)
    {}

GRINS::PhysicsFactoryBase::~PhysicsFactoryBase ( )

inline

Definition at line 52 of file physics_factory_base.h.

{};

Member Function Documentation

virtual libMesh::UniquePtr<Physics> GRINS::PhysicsFactoryBase::build_physics ( const GetPot &  input, const std::string &  physics_name  )

protectedpure virtual

Implemented in GRINS::PhysicsFactoryReactingFlows< DerivedPhysics >, GRINS::PhysicsFactoryPlaneStressSolids< DerivedPhysics >, GRINS::PhysicsFactoryIncompressibleFlow< DerivedPhysics >, GRINS::PhysicsFactoryVariableDensityFlow< DerivedPhysics >, GRINS::PhysicsFactoryHeatTransfer< DerivedPhysics >, GRINS::PhysicsFactoryIncompressibleTurbFlow< DerivedPhysics >, GRINS::PhysicsFactoryOneDStressSolids< DerivedPhysics >, and GRINS::PhysicsFactoryBasic< DerivedPhysics >.

Referenced by create().

libMesh::UniquePtr< Physics > GRINS::PhysicsFactoryBase::create ( )

inlineprivatevirtual

Subclasses implement the actual construction of the Base object in create().

Implements GRINS::FactoryAbstract< Physics >.

Definition at line 66 of file physics_factory_base.h.

References GRINS::FactoryWithGetPot< Physics >::_input, GRINS::FactoryWithGetPotPhysicsName< Physics >::_physics_name, and build_physics().

  {
    // Make sure user set the physics name
    if( _physics_name == std::string("DIE!") )
      libmesh_error_msg("ERROR: must call set_physics_name() before building Physics!");

    if( !_input )
      libmesh_error_msg("ERROR: must call set_getpot() before building Physics!");

    libMesh::UniquePtr<Physics> new_physics = this->build_physics( *_input, _physics_name );

    // Reset the _physics_name for error checking
    _physics_name = std::string("DIE!");

    libmesh_assert(new_physics);

    return new_physics;
  }

---

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

• src/physics/include/grins/physics_factory_base.h