Definition of user-defined types for convenience. More...

#include <map>
#include <string>
#include <vector>
#include <petscmat.h>
#include <petscsys.h>

Classes
struct	petibm::type::GhostPointInfo
	A data structure for a single ghost point. More...

struct	petibm::type::RowModifier
	A struct holding information about which row in a matrix should be modified based on BCs. More...

Namespaces
namespace	petibm
	A toolbox for building flow solvers.

namespace	petibm::type
	Frequently used types, structures, and enums.

Typedefs
typedef std::vector< PetscInt >	petibm::type::IntVec1D
	1D std::vector holding PetscInt. More...

typedef std::vector< IntVec1D >	petibm::type::IntVec2D
	2D std::vector holding PetscInt. More...

typedef std::vector< IntVec2D >	petibm::type::IntVec3D
	3D std::vector holding PetscInt. More...

typedef std::vector< PetscReal >	petibm::type::RealVec1D
	1D std::vector holding PetscReal. More...

typedef std::vector< RealVec1D >	petibm::type::RealVec2D
	2D std::vector holding PetscReal. More...

typedef std::vector< RealVec2D >	petibm::type::RealVec3D
	3D std::vector holding PetscReal. More...

typedef std::vector< PetscBool >	petibm::type::BoolVec1D
	1D std::vector holding PetscBool. More...

typedef std::vector< BoolVec1D >	petibm::type::BoolVec2D
	2D std::vector holding PetscBool. More...

typedef std::vector< BoolVec2D >	petibm::type::BoolVec3D
	3D std::vector holding PetscBool. More...

typedef std::vector< PetscReal * >	petibm::type::GhostedVec2D
	a vector of pointers to mimic ghosted 1D vectors. More...

typedef std::vector< GhostedVec2D >	petibm::type::GhostedVec3D
	a vector of vector pointers to mimic ghosted 2D vectors. type More...

typedef std::map< MatStencil, GhostPointInfo >	petibm::type::GhostPointsList
	A map between MatStencil and GhostPointInfo. More...

typedef std::vector< std::map< MatStencil, RowModifier > >	petibm::type::MatrixModifier
	A type that holds necessary info for a matrix modifier that modifies matrix coefficient based on BCs. More...

Enumerations
enum	petibm::type::Dir { petibm::type::x = 0 , petibm::type::y , petibm::type::z }
	Legal physical directions. More...

enum	petibm::type::Field { petibm::type::u = 0 , petibm::type::v , petibm::type::w , petibm::type::p , petibm::type::vertex }
	Legal fields. More...

enum	petibm::type::BCType { petibm::type::NOBC = 0 , petibm::type::PERIODIC , petibm::type::DIRICHLET , petibm::type::NEUMANN , petibm::type::CONVECTIVE }
	Type of boundary conditions. More...

enum	petibm::type::BCLoc { petibm::type::XMINUS = 0 , petibm::type::XPLUS , petibm::type::YMINUS , petibm::type::YPLUS , petibm::type::ZMINUS , petibm::type::ZPLUS }
	Location of a boundary. More...

enum	petibm::type::ProbeType { petibm::type::POINT = 0 , petibm::type::LINE , petibm::type::SURFACE , petibm::type::VOLUME }
	Type of probe for monitoring solution. More...

Variables
std::map< std::string, Dir >	petibm::type::str2dir {{"x", x}, {"y", y}, {"z", z}}
	Mapping between `std::string` and Dir. More...

std::map< Dir, std::string >	petibm::type::dir2str {{x, "x"}, {y, "y"}, {z, "z"}}
	Mapping between Dir and `std::string`. More...

std::map< std::string, Field >	petibm::type::str2fd
	Mapping between `std::string` and Field. More...

std::map< Field, std::string >	petibm::type::fd2str
	Mapping between Field and `std::string`. More...

std::map< std::string, BCType >	petibm::type::str2bt
	Mapping between `std::string` and BCType. More...

std::map< BCType, std::string >	petibm::type::bt2str
	mapping between BCType and `std::string`. More...

std::map< std::string, BCLoc >	petibm::type::str2bl
	Mapping between `std::string` and BCLoc. More...

std::map< BCLoc, std::string >	petibm::type::bl2str
	Mapping between BCLoc and `std::string`. More...

std::map< std::string, ProbeType >	petibm::type::str2ProbeType
	Mapping between `std::string` and ProbeType. More...

Detailed Description

Definition of user-defined types for convenience.

Definition in file type.h.

Classes