pointPatchFieldFunctions.H File Reference

Include dependency graph for pointPatchFieldFunctions.H:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Namespaces
namespace	Foam
	Namespace for OpenFOAM.
namespace	Foam::FieldOps
	Various utility functions to work on Fields.

Macros
#define	BINARY_FUNCTION(func)
#define	UNARY_OPERATOR(op, opFunc)
#define	BINARY_OPERATOR(Type1, Type2, op, opFunc)
#define	BINARY_TYPE_OPERATOR_SF(TYPE, op, opFunc)
#define	BINARY_TYPE_OPERATOR_FS(TYPE, op, opFunc)
#define	PRODUCT_OPERATOR(product, op, opFunc)

Functions
template<class Type>
void	component (pointPatchField< typename Field< Type >::cmptType > &sf, const pointPatchField< Type > &f, const direction d)
template<class Type>
void	T (pointPatchField< Type > &f1, const pointPatchField< Type > &f2)
template<class Type, direction r>
void	pow (Field< typename powProduct< Type, r >::type > &f, const pointPatchField< Type > &vf)
template<class Type>
void	sqr (Field< typename outerProduct< Type, Type >::type > &f, const pointPatchField< Type > &vf)
template<class Type>
void	magSqr (pointPatchField< scalar > &sf, const pointPatchField< Type > &f)
template<class Type>
void	mag (pointPatchField< scalar > &sf, const pointPatchField< Type > &f)
template<class Type>
void	cmptAv (pointPatchField< typename Field< Type >::cmptType > &cf, const pointPatchField< Type > &f)
template<class Type>
void	cmptMag (pointPatchField< Type > &cf, const pointPatchField< Type > &f)
template<class Type>
void	max (pointPatchField< Type > &f, const pointPatchField< Type > &f1, const pointPatchField< Type > &f2)
template<class Type>
void	max (pointPatchField< Type > &f, const pointPatchField< Type > &f1, const Type &s)
template<class Type>
void	min (pointPatchField< Type > &f, const pointPatchField< Type > &f1, const pointPatchField< Type > &f2)
template<class Type>
void	min (pointPatchField< Type > &f, const pointPatchField< Type > &f1, const Type &s)
template<class Type>
void	cmptMultiply (pointPatchField< Type > &f, const pointPatchField< Type > &f1, const pointPatchField< Type > &f2)
template<class Type>
void	cmptMultiply (pointPatchField< Type > &f, const pointPatchField< Type > &f1, const Type &s)
template<class Type>
void	cmptDivide (pointPatchField< Type > &f, const pointPatchField< Type > &f1, const pointPatchField< Type > &f2)
template<class Type>
void	cmptDivide (pointPatchField< Type > &f, const pointPatchField< Type > &f1, const Type &s)
template<class Type>
Type	min (const pointPatchField< Type > &)
template<class Type>
Type	max (const pointPatchField< Type > &)
template<class Type>
void	negate (pointPatchField< Type > &f, const pointPatchField< Type > &f1)
template<class Type>
void	multiply (pointPatchField< Type > &f, const pointPatchField< scalar > &f1, const pointPatchField< Type > &f2)
template<class Type>
void	multiply (pointPatchField< Type > &f, const pointPatchField< Type > &f1, const pointPatchField< scalar > &f2)
template<class Type>
void	divide (pointPatchField< Type > &f, const pointPatchField< Type > &f1, const pointPatchField< scalar > &f2)
template<class Type>
void	multiply (pointPatchField< Type > &f, const scalar &s, const pointPatchField< Type > &f1)
template<class Type>
void	multiply (pointPatchField< Type > &f, const pointPatchField< Type > &f1, const scalar &s)
template<class Type>
void	divide (pointPatchField< Type > &f, const pointPatchField< Type > &f1, const scalar &s)
template<class Type1, class Type2>
void	add (pointPatchField< typename typeOfSum< Type1, Type2 >::type > &f, const pointPatchField< Type1 > &f1, const pointPatchField< Type2 > &f2)
template<class Type, class Form, class Cmpt, direction nCmpt>
void	add (pointPatchField< typename typeOfSum< Type, Form >::type > &f, const pointPatchField< Type > &f1, const VectorSpace< Form, Cmpt, nCmpt > &vs)
template<class Form, class Cmpt, direction nCmpt, class Type>
void	add (pointPatchField< typename typeOfSum< Form, Type >::type > &f, const VectorSpace< Form, Cmpt, nCmpt > &vs, const pointPatchField< Type > &f1)
template<class Type1, class Type2>
void	subtract (pointPatchField< typename typeOfSum< Type1, Type2 >::type > &f, const pointPatchField< Type1 > &f1, const pointPatchField< Type2 > &f2)
template<class Type, class Form, class Cmpt, direction nCmpt>
void	subtract (pointPatchField< typename typeOfSum< Type, Form >::type > &f, const pointPatchField< Type > &f1, const VectorSpace< Form, Cmpt, nCmpt > &vs)
template<class Form, class Cmpt, direction nCmpt, class Type>
void	subtract (pointPatchField< typename typeOfSum< Form, Type >::type > &f, const VectorSpace< Form, Cmpt, nCmpt > &vs, const pointPatchField< Type > &f1)
template<class Type1, class Type2>
void	outer (pointPatchField< typename outerProduct< Type1, Type2 >::type > &f, const pointPatchField< Type1 > &f1, const pointPatchField< Type2 > &f2)
template<class Type, class Form, class Cmpt, direction nCmpt>
void	outer (pointPatchField< typename outerProduct< Type, Form >::type > &f, const pointPatchField< Type > &f1, const VectorSpace< Form, Cmpt, nCmpt > &vs)
template<class Form, class Cmpt, direction nCmpt, class Type>
void	outer (pointPatchField< typename outerProduct< Form, Type >::type > &f, const VectorSpace< Form, Cmpt, nCmpt > &vs, const pointPatchField< Type > &f1)
template<class Type1, class Type2>
void	cross (pointPatchField< typename crossProduct< Type1, Type2 >::type > &f, const pointPatchField< Type1 > &f1, const pointPatchField< Type2 > &f2)
template<class Type, class Form, class Cmpt, direction nCmpt>
void	cross (pointPatchField< typename crossProduct< Type, Form >::type > &f, const pointPatchField< Type > &f1, const VectorSpace< Form, Cmpt, nCmpt > &vs)
template<class Form, class Cmpt, direction nCmpt, class Type>
void	cross (pointPatchField< typename crossProduct< Form, Type >::type > &f, const VectorSpace< Form, Cmpt, nCmpt > &vs, const pointPatchField< Type > &f1)
template<class Type1, class Type2>
void	dot (pointPatchField< typename innerProduct< Type1, Type2 >::type > &f, const pointPatchField< Type1 > &f1, const pointPatchField< Type2 > &f2)
template<class Type, class Form, class Cmpt, direction nCmpt>
void	dot (pointPatchField< typename innerProduct< Type, Form >::type > &f, const pointPatchField< Type > &f1, const VectorSpace< Form, Cmpt, nCmpt > &vs)
template<class Form, class Cmpt, direction nCmpt, class Type>
void	dot (pointPatchField< typename innerProduct< Form, Type >::type > &f, const VectorSpace< Form, Cmpt, nCmpt > &vs, const pointPatchField< Type > &f1)
template<class Type1, class Type2>
void	dotdot (pointPatchField< typename scalarProduct< Type1, Type2 >::type > &f, const pointPatchField< Type1 > &f1, const pointPatchField< Type2 > &f2)
template<class Type, class Form, class Cmpt, direction nCmpt>
void	dotdot (pointPatchField< typename scalarProduct< Type, Form >::type > &f, const pointPatchField< Type > &f1, const VectorSpace< Form, Cmpt, nCmpt > &vs)
template<class Form, class Cmpt, direction nCmpt, class Type>
void	dotdot (pointPatchField< typename scalarProduct< Form, Type >::type > &f, const VectorSpace< Form, Cmpt, nCmpt > &vs, const pointPatchField< Type > &f1)
void	hdual (pointPatchField< vector > &, const pointPatchField< tensor > &)
void	hdual (pointPatchField< tensor > &, const pointPatchField< vector > &)
void	diag (pointPatchField< vector > &, const pointPatchField< tensor > &)
void	tr (pointPatchField< scalar > &, const pointPatchField< tensor > &)
void	dev (pointPatchField< tensor > &, const pointPatchField< tensor > &)
void	dev2 (pointPatchField< tensor > &, const pointPatchField< tensor > &)
void	det (pointPatchField< scalar > &, const pointPatchField< tensor > &)
void	inv (pointPatchField< tensor > &, const pointPatchField< tensor > &)
void	symm (pointPatchField< tensor > &, const pointPatchField< tensor > &)
void	twoSymm (pointPatchField< tensor > &, const pointPatchField< tensor > &)
void	skew (pointPatchField< tensor > &, const pointPatchField< tensor > &)
template<class Tout, class T1, class UnaryOp>
void	assign (pointPatchField< Tout > &result, const pointPatchField< T1 > &a, const UnaryOp &op)
template<class Tout, class T1, class T2, class BinaryOp>
void	assign (pointPatchField< Tout > &result, const pointPatchField< T1 > &a, const pointPatchField< T2 > &b, const BinaryOp &bop)
template<class T, class BinaryOp>
void	ternary (pointPatchField< T > &result, const pointPatchField< T > &a, const pointPatchField< T > &b, const BinaryOp &bop)
template<class T, class BoolType, class FlipOp>
void	ternarySelect (pointPatchField< T > &result, const pointPatchField< BoolType > &cond, const pointPatchField< T > &a, const pointPatchField< T > &b, const FlipOp &flip)

Detailed Description

Original source file pointPatchFieldFunctions.H

Note

Many functions are not required or supported on pointPatchFields but are made available as dummy operations to ensure that various FieldFieldFunctions will be definable.

Definition in file pointPatchFieldFunctions.H.

Macro Definition Documentation

BINARY_FUNCTION

#define BINARY_FUNCTION

(

func

)

Value:

                                                                               \
template<class Type>                                                           \
inline void func                                                               \
(                                                                              \
    pointPatchField<Type>& f,                                                  \
    const pointPatchField<Type>& f1,                                           \
    const pointPatchField<Type>& f2                                            \
)                                                                              \
{}                                                                             \
                                                                               \
template<class Type>                                                           \
inline void func                                                               \
(                                                                              \
    pointPatchField<Type>& f,                                                  \
    const pointPatchField<Type>& f1,                                           \
    const Type& s                                                              \
)                                                                              \
{}

Definition at line 107 of file pointPatchFieldFunctions.H.

UNARY_OPERATOR

#define UNARY_OPERATOR	(		op,
			opFunc )

Value:

                                                                               \
template<class Type>                                                           \
inline void opFunc                                                             \
(                                                                              \
    pointPatchField<Type>& f,                                                  \
    const pointPatchField<Type>& f1                                            \
)                                                                              \
{}

Definition at line 150 of file pointPatchFieldFunctions.H.

BINARY_OPERATOR

#define BINARY_OPERATOR	(		Type1,
			Type2,
			op,
			opFunc )

Value:

                                                                               \
template<class Type>                                                           \
inline void opFunc                                                             \
(                                                                              \
    pointPatchField<Type>& f,                                                  \
    const pointPatchField<Type1>& f1,                                          \
    const pointPatchField<Type2>& f2                                           \
)                                                                              \
{}

Definition at line 162 of file pointPatchFieldFunctions.H.

BINARY_TYPE_OPERATOR_SF

#define BINARY_TYPE_OPERATOR_SF	(		TYPE,
			op,
			opFunc )

Value:

                                                                               \
template<class Type>                                                           \
inline void opFunc                                                             \
(                                                                              \
    pointPatchField<Type>& f,                                                  \
    const TYPE& s,                                                             \
    const pointPatchField<Type>& f1                                            \
)                                                                              \
{}

Definition at line 177 of file pointPatchFieldFunctions.H.

BINARY_TYPE_OPERATOR_FS

#define BINARY_TYPE_OPERATOR_FS	(		TYPE,
			op,
			opFunc )

Value:

                                                                               \
template<class Type>                                                           \
inline void opFunc                                                             \
(                                                                              \
    pointPatchField<Type>& f,                                                  \
    const pointPatchField<Type>& f1,                                           \
    const TYPE& s                                                              \
)                                                                              \
{}

Definition at line 189 of file pointPatchFieldFunctions.H.

PRODUCT_OPERATOR

#define PRODUCT_OPERATOR	(		product,
			op,
			opFunc )

Definition at line 206 of file pointPatchFieldFunctions.H.