physics_factory.h

Go to the documentation of this file.

//-----------------------------------------------------------------------bl-
//--------------------------------------------------------------------------
//
// GRINS - General Reacting Incompressible Navier-Stokes
//
// Copyright (C) 2014-2015 Paul T. Bauman, Roy H. Stogner
// Copyright (C) 2010-2013 The PECOS Development Team
//
// This library is free software; you can redistribute it and/or
// modify it under the terms of the Version 2.1 GNU Lesser General
// Public License as published by the Free Software Foundation.
//
// This library is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
// Lesser General Public License for more details.
//
// You should have received a copy of the GNU Lesser General Public
// License along with this library; if not, write to the Free Software
// Foundation, Inc. 51 Franklin Street, Fifth Floor,
// Boston, MA  02110-1301  USA
//
//-----------------------------------------------------------------------el-


#ifndef GRINS_PHYSICS_FACTORY_H
#define GRINS_PHYSICS_FACTORY_H

// C++
#include <string>

// GRINS stuff
#include "grins/var_typedefs.h"

// libMesh forward declarations
class GetPot;

namespace GRINS
{

  class PhysicsFactory
  {
  public:
    
    PhysicsFactory();

    virtual ~PhysicsFactory();
    
    GRINS::PhysicsList build(const GetPot& input);

    typedef std::tr1::shared_ptr<Physics> PhysicsPtr;
    typedef std::pair< std::string, PhysicsPtr > PhysicsPair;

  protected:


    virtual void add_physics( const GetPot& input,
                              const std::string& physics_to_add,
                              GRINS::PhysicsList& physics_list );


    virtual void check_physics_consistency( const GRINS::PhysicsList& physics_list );

    void physics_consistency_error( const std::string physics_checked,
                                    const std::string physics_required ) const;

  }; // class PhysicsFactory

} // namespace GRINS

#endif // GRINS_PHYSICS_FACTORY_H