qoi_factory.h

Go to the documentation of this file.

//-----------------------------------------------------------------------bl-
//--------------------------------------------------------------------------
//
// GRINS - General Reacting Incompressible Navier-Stokes
//
// Copyright (C) 2014-2016 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 QOI_FACTORY_H
#define QOI_FACTORY_H

//libMesh
#include "libmesh/getpot.h"

//GRINS
#include "grins/composite_qoi.h"

// shared_ptr
#include "grins/shared_ptr.h"

namespace GRINS
{
  class QoIFactory
  {
  public:

    QoIFactory();
    
    virtual ~QoIFactory();

    virtual SharedPtr<CompositeQoI> build(const GetPot& input);

  protected:

    virtual void add_qoi( const GetPot& input,
                          const std::string& qoi_name,
                          SharedPtr<CompositeQoI>& qois );

    virtual void check_qoi_physics_consistency( const GetPot& input,
                                                const std::string& qoi_name );

    virtual void echo_qoi_list( SharedPtr<CompositeQoI>& qois );

    void consistency_helper( const std::set<std::string>& requested_physics,
                             const std::set<std::string>& required_physics, 
                             const std::string& qoi_name );

    void consistency_error_msg( const std::string& qoi_name, const std::set<std::string>& required_physics );

  };
}
#endif // QOI_FACTORY_H