petibm::misc Namespace Reference

A namespace holding miscellaneous functions. More...

Classes
class	BiLinInterp
	Class to perform a bilinear interpolation at a point in a 3D domain. More...
class	LinInterpBase
	Abstract Base Class of a linear interpolation object. More...
struct	LoopBound
	A helper struct to make looping function easier. More...
class	ProbeBase
	Abstract Base Class of a probe. More...
class	ProbePoint
	Probe class to monitor the solution at a single point. More...
class	ProbeVolume
	Probe class to monitor a volume region of the domain. More...
class	TriLinInterp
	Class to perform a trilinear interpolation at a point in a 3D domain. More...

Functions
PetscErrorCode	createLinInterp (const MPI_Comm &comm, const type::RealVec1D &point, const type::Mesh &mesh, const type::Field &field, type::LinInterp &interp)
	Factory function to create a linear interpolation object. More...
PetscErrorCode	checkPeriodicBC (const type::IntVec2D &bcTypes, type::BoolVec2D &periodic)
	Check if there is any periodic boundary condition and if these periodic BCs make sense. More...
PetscErrorCode	checkBoundaryProc (const DM &da, const type::IntVec1D &n, const type::BCLoc &loc, PetscBool &onThisProc)
	Check if a boundary is on this process. More...
PetscErrorCode	getGhostPointList (const type::Mesh &mesh, const type::Field &field, const type::BCLoc &loc, type::GhostPointsList &points)
	Get a list of ghost points on a desired boundary. More...
PetscErrorCode	getPerpendAxes (const PetscInt &self, type::IntVec1D &pAxes)
	An utility to get the perpendicular axes of a desired axis. More...
PetscErrorCode	getGhostTargetStencil (const type::IntVec1D &n, const type::BCLoc &loc, const type::IntVec1D &pIdx, MatStencil &ghost, MatStencil &target)
	Get the stencils of a desired ghost point and its corresponding boundary point. More...
PetscErrorCode	stretchGrid (const PetscReal &bg, const PetscReal &ed, const PetscInt &n, const PetscReal &r, type::RealVec1D &dL)
	Calculate and return cell sizes of stretched grid in one direction. More...
PetscErrorCode	doubleLoops (const LoopBound &bound1, const LoopBound &bound2, const std::function< PetscErrorCode(const PetscInt &, const PetscInt &)> &f)
	A helper function to carry out a double loop on a given function. More...
PetscErrorCode	tripleLoops (const LoopBound &bound1, const LoopBound &bound2, const LoopBound &bound3, const std::function< PetscErrorCode(const PetscInt &, const PetscInt &, const PetscInt &)> &f)
	A helper function to carry out a triple loop on a given function. More...
PetscErrorCode	createProbe (const MPI_Comm &comm, const YAML::Node &node, const type::Mesh &mesh, type::Probe &probe)
	Factory function to create a probe to monitor the solution. More...

Detailed Description

A namespace holding miscellaneous functions.