variable_warehouse.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 GRINS_VARIABLE_WAREHOUSE_H
#define GRINS_VARIABLE_WAREHOUSE_H

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

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

namespace GRINS
{
  namespace GRINSPrivate
  {

    class VariableWarehouse
    {
    public:
      VariableWarehouse(){};

      ~VariableWarehouse(){};

      static bool is_registered( const std::string& var_name );


      static void check_and_register_variable( const std::string& var_name,
                                               const FEVariablesBase& variable );

      static void register_variable( const std::string& var_name,
                                     const FEVariablesBase& variable );

      static const FEVariablesBase& get_variable( const std::string& var_name );

      template <typename DerivedType>
      static const DerivedType& get_variable_subclass( const std::string& var_name )
      {
        const FEVariablesBase& var_base = VariableWarehouse::get_variable(var_name);

        const DerivedType& derived_var = libMesh::cast_ref<const DerivedType&>( var_base);

        return derived_var;
      }

      static void clear()
      { var_map().clear(); }

    protected:

      static std::map<std::string,const FEVariablesBase*>& var_map();

    };

    inline
    bool VariableWarehouse::is_registered( const std::string& var_name )
    {
      bool var_found = (var_map().find(var_name) != var_map().end() );
      return var_found;
    }

    inline
    void VariableWarehouse::check_and_register_variable( const std::string& var_name,
                                                         const FEVariablesBase& variable )
    {
      if( !VariableWarehouse::is_registered(var_name) )
        VariableWarehouse::register_variable(var_name,variable);
    }

    inline
    void VariableWarehouse::register_variable( const std::string& var_name,
                                               const FEVariablesBase& variable )
    {
      if( VariableWarehouse::is_registered(var_name) )
        libmesh_error_msg("ERROR: Duplicate FEVariable registration not allowed!");

      var_map()[var_name] = &variable;
    }

    inline
    const FEVariablesBase& VariableWarehouse::get_variable( const std::string& var_name )
    {
      if( !VariableWarehouse::is_registered(var_name) )
        libmesh_error_msg("ERROR: Could not find FEVariable "+var_name+"!");

      const FEVariablesBase* var_ptr = var_map()[var_name];

      if( !var_ptr )
        libmesh_error_msg("ERROR: FEVariable "+var_name+" is an invalid pointer!");

      return *var_ptr;
    }

  } // end namespace GRINSPrivate

} // end namespace GRINS

#endif // GRINS_VARIABLE_WAREHOUSE_H