fe_variables_base.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_FE_VARIABLES_BASE_H
#define GRINS_FE_VARIABLES_BASE_H

// C++
#include <vector>
#include <string>
#include <limits>

// GRINS
#include "grins/grins_enums.h"
#include "grins/var_typedefs.h"
#include "grins/variables_parsing.h"

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

// libMesh forward declarations
class GetPot;
namespace libMesh
{
  class FEMSystem;
}

namespace GRINS
{
  class FEVariablesBase
  {
  public:

    FEVariablesBase( bool is_constraint_var )
      : _is_constraint_var(is_constraint_var),
        _neumann_bc_sign(1.0)
    {}

    ~FEVariablesBase(){};


    virtual void init( libMesh::FEMSystem* system ) =0;

    bool is_constraint_var() const
    { return _is_constraint_var; }


    void set_neumann_bc_is_positive( bool is_positive );

    libMesh::Real neumann_bc_sign() const
    { return _neumann_bc_sign; }


    const std::vector<std::string>& active_var_names() const
    { return _var_names; }

    const std::vector<VariableIndex>& var_indices() const
    { return _vars; }

  protected:


    void parse_names_from_input( const GetPot& input,
                                 const std::string& subsection,
                                 std::vector<std::string>& var_names,
                                 const std::vector<std::string>& default_names );


    void duplicate_name_section_check( const GetPot& input ) const;


    bool check_dep_name_input( const GetPot& input,
                               const std::string& new_subsection ) const;

    std::vector<VariableIndex> _vars;

    std::vector<std::string> _var_names;

    std::vector<GRINSEnums::FEFamily> _family;

    std::vector<GRINSEnums::Order> _order;


    bool _is_constraint_var;


    libMesh::Real _neumann_bc_sign;

  };

  inline
  void FEVariablesBase::set_neumann_bc_is_positive( bool is_positive )
  {
    if(is_positive)
      _neumann_bc_sign = 1.0;
    else
      _neumann_bc_sign = -1.0;
  }

} // end namespace GRINS

#endif // GRINS_FE_VARIABLES_BASE_H