GRINS-0.8.0
var_typedefs.h
Go to the documentation of this file.
1 //-----------------------------------------------------------------------bl-
2 //--------------------------------------------------------------------------
3 //
4 // GRINS - General Reacting Incompressible Navier-Stokes
5 //
6 // Copyright (C) 2014-2017 Paul T. Bauman, Roy H. Stogner
7 // Copyright (C) 2010-2013 The PECOS Development Team
8 //
9 // This library is free software; you can redistribute it and/or
10 // modify it under the terms of the Version 2.1 GNU Lesser General
11 // Public License as published by the Free Software Foundation.
12 //
13 // This library is distributed in the hope that it will be useful,
14 // but WITHOUT ANY WARRANTY; without even the implied warranty of
15 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
16 // Lesser General Public License for more details.
17 //
18 // You should have received a copy of the GNU Lesser General Public
19 // License along with this library; if not, write to the Free Software
20 // Foundation, Inc. 51 Franklin Street, Fifth Floor,
21 // Boston, MA 02110-1301 USA
22 //
23 //-----------------------------------------------------------------------el-
24 
25 #ifndef GRINS_VAR_TYPEDEFS_H
26 #define GRINS_VAR_TYPEDEFS_H
27 
28 // C++
29 #include <string>
30 #include <map>
31 #include <limits>
32 
33 // libMesh
34 #include "libmesh/id_types.h"
35 
36 // GRINS
37 #include "grins/shared_ptr.h"
38 
39 namespace GRINS
40 {
42  class Physics;
43 
45  typedef unsigned int VariableIndex;
46 
48 
50  const unsigned int invalid_var_index = std::numeric_limits<unsigned int>::max();
51 
52  typedef std::string VariableName;
53 
55 
56  typedef libMesh::boundary_id_type BoundaryID;
57 
59  typedef std::map< std::string,SharedPtr<GRINS::Physics> > PhysicsList;
60 
62  typedef std::map< std::string,SharedPtr<GRINS::Physics> >::const_iterator PhysicsListIter;
63 
64 }
65 #endif //GRINS_VAR_TYPEDEFS_H
unsigned int VariableIndex
More descriptive name of the type used for variable indices.
Definition: var_typedefs.h:42
Physics abstract base class. Defines API for physics to be added to MultiphysicsSystem.
Definition: physics.h:106
libMesh::boundary_id_type BoundaryID
More descriptive name of the type used for boundary ids.
Definition: var_typedefs.h:56
const unsigned int invalid_var_index
Invalid varaible index id.
Definition: var_typedefs.h:50
std::string VariableName
Definition: var_typedefs.h:52
GRINS namespace.
std::map< std::string, SharedPtr< GRINS::Physics > > PhysicsList
Container for GRINS::Physics object pointers.
Definition: var_typedefs.h:59
std::map< std::string, SharedPtr< GRINS::Physics > >::const_iterator PhysicsListIter
Iterator for PhysicsList.
Definition: var_typedefs.h:62

Generated on Tue Dec 19 2017 12:47:28 for GRINS-0.8.0 by  doxygen 1.8.9.1