Top-level namespace for coolfluid. More...

Namespaces
	BlockMeshReader

	CGAL
	Classes for CGAL mesh format operations.

	common
	Most basic kernel library.

	detail

	math
	Basic Classes for Mathematical applications used by COOLFluiD.

	mesh
	Basic Classes for Mesh applications used by COOLFluiD.

	physics
	Basic Classes for Physics applications used by CF.

	python
	Basic Classes for Python wrapper classes used by CF.

	solver
	Basic Classes for Solver applications used by CF.

	TestActions

	Tools
	Helpful non-essential libraries to use with COOLFluiD.

	tutorial
	Contains Tutorial classes and functions.

	UFEM

	ui

	vtk
	Classes for VTK operations.

	zoltan
	Classes for Zoltan operations.

Classes
struct	Deleter
	functor for deleting objects by calling the safer delete_ptr function More...

class	Handle
	Safe pointer to an object. This is the supported method for referring to components. More...

class	NonInstantiable
	Derive from this class if you want a class that is not instantiable. More...

Typedefs
typedef unsigned int	Uint
	typedef for unsigned int More...

typedef Eigen::Matrix< Real, Eigen::Dynamic, Eigen::Dynamic >	RealMatrix
	Dynamic sized matrix of Real scalars. More...

typedef Eigen::Matrix< Real, Eigen::Dynamic, 1 >	RealVector
	Dynamic sized column vector. More...

typedef RealVector	RealColVector
	Dynamic sized column vector (alternative naming) More...

typedef Eigen::Matrix< Real, 1, Eigen::Dynamic >	RealRowVector
	Dynamic sized row vector. More...

typedef Eigen::Matrix< Real, 2, 2 >	RealMatrix2
	Fixed size 2x2 matrix. More...

typedef Eigen::Matrix< Real, 3, 3 >	RealMatrix3
	Fixed size 3x3 matrix. More...

typedef Eigen::Matrix< Real, 4, 4 >	RealMatrix4
	Fixed size 4x4 matrix. More...

typedef Eigen::Matrix< Real, 1, 1 >	RealVector1
	Fixed size 1x1 column vector. More...

typedef Eigen::Matrix< Real, 2, 1 >	RealVector2
	Fixed size 2x1 column vector. More...

typedef Eigen::Matrix< Real, 3, 1 >	RealVector3
	Fixed size 3x1 column vector. More...

typedef Eigen::Matrix< Real, 4, 1 >	RealVector4
	Fixed size 4x1 column vector. More...

typedef Eigen::Matrix< Real, 1, 1 >	RealRowVector1
	Fixed size 1x1 row vector. More...

typedef Eigen::Matrix< Real, 1, 2 >	RealRowVector2
	Fixed size 1x2 row vector. More...

typedef Eigen::Matrix< Real, 1, 3 >	RealRowVector3
	Fixed size 1x3 row vector. More...

typedef Eigen::Matrix< Real, 1, 4 >	RealRowVector4
	Fixed size 1x4 row vector. More...

Enumerations
enum	LogLevel { SILENT = 0, ERROR = 1, WARNING = 2, INFO = 3, DEBUG = 4, VERBOSE = 10 }

enum	Dim { DIM_0D, DIM_1D, DIM_2D, DIM_3D }
	Enumeration of the dimensions. More...

enum	CoordXYZ { XX, YY, ZZ }
	Enumeration of the coordinates indexes. More...

enum	CoordRef { KSI, ETA, ZTA }
	Enumeration of the reference coordinates indexes. More...

enum	Side { LEFT, RIGHT }
	Enumeration of sides. More...

enum	VarType { ARRAY =0, SCALAR =1, VECTOR_2D =2, VECTOR_3D =3, TENSOR_2D =4, TENSOR_3D =9 }
	Variable types. More...

Functions
template<class TYPE >
void	delete_ptr (TYPE *&ptr)
	Definition of the default precision. More...

template<class TYPE >
void	delete_ptr_array (TYPE *&ptr)
	Deletes a pointer to array and makes sure it is set to nullptr afterwards. More...

template<typename T >
bool	is_not_null (T ptr)
	predicate for comparison to nullptr More...

template<typename T >
bool	is_null (T ptr)
	predicate for comparison to nullptr More...

template<typename T , typename U >
bool	operator== (const Handle< T > &a, const Handle< U > &b)

template<typename T , typename U >
bool	operator== (const Handle< T > &a, const U b)

template<typename T , typename U >
bool	operator== (const U a, const Handle< T > &b)

template<typename T , typename U >
bool	operator!= (const Handle< T > &a, const Handle< U > &b)

template<typename T , typename U >
bool	operator!= (const Handle< T > &a, const U b)

template<typename T >
bool	operator!= (const Handle< T > &a, const int b)

template<typename T >
bool	operator== (const Handle< T > &a, const int b)

template<typename T >
bool	operator!= (const int b, const Handle< T > &a)

template<typename T >
bool	operator== (const int b, const Handle< T > &a)

template<typename T , typename U >
bool	operator!= (const U a, const Handle< T > &b)

template<typename T , typename U >
bool	operator< (const Handle< T > &a, const Handle< U > &b)

template<typename T >
Handle< T >	make_handle (const boost::shared_ptr< T > &p)
	Helper function to make a handle. More...

Variables
common::ComponentBuilder< solver::ActionDirector, common::ActionDirector, solver::LibSolver >	SolverActionDirector_Builder

common::ComponentBuilder< solver::ActionDirectorWithSkip, common::ActionDirector, solver::LibSolver >	SolverActionDirectorWithSkip_Builder

Detailed Description

Top-level namespace for coolfluid.

COOLFluiD Classes.

This namespace holds all coolfluid related namespaces, classes, functions.

Todo:: remove

Typedef Documentation

typedef RealVector RealColVector

Dynamic sized column vector (alternative naming)

Definition at line 28 of file MatrixTypes.hpp.

typedef Eigen::Matrix<Real, Eigen::Dynamic, Eigen::Dynamic> RealMatrix

Dynamic sized matrix of Real scalars.

Definition at line 22 of file MatrixTypes.hpp.

typedef Eigen::Matrix<Real, 2, 2> RealMatrix2

Fixed size 2x2 matrix.

Definition at line 34 of file MatrixTypes.hpp.

typedef Eigen::Matrix<Real, 3, 3> RealMatrix3

Fixed size 3x3 matrix.

Definition at line 35 of file MatrixTypes.hpp.

typedef Eigen::Matrix<Real, 4, 4> RealMatrix4

Fixed size 4x4 matrix.

Definition at line 36 of file MatrixTypes.hpp.

typedef Eigen::Matrix<Real, 1, Eigen::Dynamic> RealRowVector

Dynamic sized row vector.

Definition at line 31 of file MatrixTypes.hpp.

typedef Eigen::Matrix<Real, 1, 1> RealRowVector1

Fixed size 1x1 row vector.

Definition at line 45 of file MatrixTypes.hpp.

typedef Eigen::Matrix<Real, 1, 2> RealRowVector2

Fixed size 1x2 row vector.

Definition at line 46 of file MatrixTypes.hpp.

typedef Eigen::Matrix<Real, 1, 3> RealRowVector3

Fixed size 1x3 row vector.

Definition at line 47 of file MatrixTypes.hpp.

typedef Eigen::Matrix<Real, 1, 4> RealRowVector4

Fixed size 1x4 row vector.

Definition at line 48 of file MatrixTypes.hpp.

typedef Eigen::Matrix<Real, Eigen::Dynamic, 1> RealVector

Dynamic sized column vector.

Definition at line 25 of file MatrixTypes.hpp.

typedef Eigen::Matrix<Real, 1, 1> RealVector1

Fixed size 1x1 column vector.

Definition at line 39 of file MatrixTypes.hpp.

typedef Eigen::Matrix<Real, 2, 1> RealVector2

Fixed size 2x1 column vector.

Definition at line 40 of file MatrixTypes.hpp.

typedef Eigen::Matrix<Real, 3, 1> RealVector3

Fixed size 3x1 column vector.

Definition at line 41 of file MatrixTypes.hpp.

typedef Eigen::Matrix<Real, 4, 1> RealVector4

Fixed size 4x1 column vector.

Definition at line 42 of file MatrixTypes.hpp.

typedef unsigned int Uint

typedef for unsigned int

Definition at line 90 of file CF.hpp.

Enumeration Type Documentation

enum CoordRef

Enumeration of the reference coordinates indexes.

Enumerator
KSI
ETA
ZTA

Definition at line 19 of file Defs.hpp.

enum CoordXYZ

Enumeration of the coordinates indexes.

Enumerator
XX
YY
ZZ

Definition at line 17 of file Defs.hpp.

enum Dim

Enumeration of the dimensions.

Enumerator
DIM_0D
DIM_1D
DIM_2D
DIM_3D

Definition at line 15 of file Defs.hpp.

enum LogLevel

Output levels for the Log facility

Author: Quentin Gasper; Willem Deconinck

Enumerator
SILENT
ERROR
WARNING
INFO
DEBUG
VERBOSE

Definition at line 20 of file LogLevel.hpp.

enum Side

Enumeration of sides.

Enumerator
LEFT
RIGHT

Definition at line 21 of file Defs.hpp.

enum VarType

Variable types.

Enumerator
ARRAY
SCALAR
VECTOR_2D
VECTOR_3D
TENSOR_2D
TENSOR_3D

Definition at line 23 of file Defs.hpp.

Function Documentation

void cf3::delete_ptr ( TYPE *& ptr )

Definition of the default precision.

Deletes a pointer and makes sure it is set to nullptr afterwards

It would not have to check for nullptr before deletion, as deleting a null is explicitely allowed by the standard. Nevertheless it does check, to avoid problems with not so compliant compilers. Do not use this function with data allocate with new [].

Author: Tiago Quintino

Precondition: ptr has been allocated with operator new

Parameters

ptr	pointer to be deleted

Postcondition: ptr equals nullptr

Definition at line 116 of file CF.hpp.

void cf3::delete_ptr_array ( TYPE *& ptr )

Deletes a pointer to array and makes sure it is set to nullptr afterwards.

See also: delete_ptr

Author: Tiago Quintino

Precondition: ptr has been allocated with operator new []

Parameters

ptr	pointer to be deleted

Postcondition: ptr equals nullptr

Definition at line 132 of file CF.hpp.

bool cf3::is_not_null ( T ptr )

predicate for comparison to nullptr

Definition at line 147 of file CF.hpp.

bool cf3::is_null ( T ptr )

predicate for comparison to nullptr

Definition at line 151 of file CF.hpp.

Handle<T> cf3::make_handle ( const boost::shared_ptr< T > & p )

Helper function to make a handle.

Definition at line 234 of file Handle.hpp.

bool cf3::operator!=	(	const Handle< T > &	a,
		const Handle< U > &	b
	)

inline

Definition at line 184 of file Handle.hpp.

bool cf3::operator!=	(	const Handle< T > &	a,
		const U	b
	)

inline

Definition at line 189 of file Handle.hpp.

bool cf3::operator!=	(	const Handle< T > &	a,
		const int	b
	)

inline

Definition at line 195 of file Handle.hpp.

bool cf3::operator!=	(	const int	b,
		const Handle< T > &	a
	)

inline

Definition at line 209 of file Handle.hpp.

bool cf3::operator!=	(	const U	a,
		const Handle< T > &	b
	)

inline

Definition at line 222 of file Handle.hpp.

bool cf3::operator<	(	const Handle< T > &	a,
		const Handle< U > &	b
	)

inline

Definition at line 227 of file Handle.hpp.

bool cf3::operator==	(	const Handle< T > &	a,
		const Handle< U > &	b
	)

inline

Definition at line 169 of file Handle.hpp.

bool cf3::operator==	(	const Handle< T > &	a,
		const U	b
	)

inline

Definition at line 174 of file Handle.hpp.

bool cf3::operator==	(	const U	a,
		const Handle< T > &	b
	)

inline

Definition at line 179 of file Handle.hpp.

bool cf3::operator==	(	const Handle< T > &	a,
		const int	b
	)

inline

Definition at line 202 of file Handle.hpp.

bool cf3::operator==	(	const int	b,
		const Handle< T > &	a
	)

inline

Definition at line 216 of file Handle.hpp.

Variable Documentation

common::ComponentBuilder< solver::ActionDirector, common::ActionDirector, solver::LibSolver > SolverActionDirector_Builder

Definition at line 27 of file ActionDirector.cpp.

common::ComponentBuilder< solver::ActionDirectorWithSkip, common::ActionDirector, solver::LibSolver > SolverActionDirectorWithSkip_Builder

Definition at line 27 of file ActionDirectorWithSkip.cpp.

Namespaces

Classes

Typedefs

Enumerations

Functions

Variables

Detailed Description

Typedef Documentation

Enumeration Type Documentation

Function Documentation

Variable Documentation