OpenFOAM logo
Open Source CFD Toolkit

dimensionedType.H File Reference


Detailed Description

View dimensionedType.H
License
This file is part of OpenFOAM.

OpenFOAM is free software; you can redistribute it and/or modify it
under the terms of the GNU General Public License as published by the
Free Software Foundation; either version 2 of the License, or (at your
option) any later version.

OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
for more details.

You should have received a copy of the GNU General Public License
along with OpenFOAM; if not, write to the Free Software Foundation,
Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
Description
Generic dimensioned Type class

Source files

Definition in file dimensionedType.H.

Go to the source code of this file.

Namespaces

namespace  Foam

Classes

class  dimensioned

Defines

#define PRODUCT_OPERATOR(product, op, opFunc)

Functions

template<class Type>
Istream & operator>> (Istream &, dimensioned< Type > &)
template<class Type>
Ostream & operator<< (Ostream &, const dimensioned< Type > &)
template<class Type, int r>
dimensioned< typename powProduct<
Type, r >::type > 
pow (const dimensioned< Type > &, typename powProduct< Type, r >::type=pTraits< typename powProduct< Type, r >::type >::zero)
template<class Type>
dimensioned< typename outerProduct<
Type, Type >::type > 
sqr (const dimensioned< Type > &)
template<class Type>
dimensioned< scalar > magSqr (const dimensioned< Type > &)
template<class Type>
dimensioned< scalar > mag (const dimensioned< Type > &)
template<class Type>
dimensioned< Type > scale (const dimensioned< Type > &, const dimensioned< Type > &)
template<class Type>
dimensioned< Type > max (const dimensioned< Type > &, const dimensioned< Type > &)
template<class Type>
dimensioned< Type > min (const dimensioned< Type > &, const dimensioned< Type > &)
template<class Type>
bool operator> (const dimensioned< Type > &, const dimensioned< Type > &)
template<class Type>
bool operator< (const dimensioned< Type > &, const dimensioned< Type > &)
template<class Type>
dimensioned< Type > operator+ (const dimensioned< Type > &, const dimensioned< Type > &)
template<class Type>
dimensioned< Type > operator- (const dimensioned< Type > &)
template<class Type>
dimensioned< Type > operator- (const dimensioned< Type > &, const dimensioned< Type > &)
template<class Type>
dimensioned< Type > operator * (const dimensioned< scalar > &, const dimensioned< Type > &)
template<class Type>
dimensioned< Type > operator/ (const dimensioned< Type > &, const dimensioned< scalar > &)
template<class Type1, class Type2>
dimensioned< typename outerProduct<
Type1, Type2 >::type > 
operator * (const dimensioned< Type1 > &, const dimensioned< Type2 > &)
template<class Type, class Form, class Cmpt, int nCmpt>
dimensioned< typename outerProduct<
Type, Form >::type > 
operator * (const dimensioned< Type > &, const VectorSpace< Form, Cmpt, nCmpt > &)
template<class Type, class Form, class Cmpt, int nCmpt>
dimensioned< typename outerProduct<
Form, Type >::type > 
operator * (const VectorSpace< Form, Cmpt, nCmpt > &, const dimensioned< Type > &)
template<class Type1, class Type2>
dimensioned< typename crossProduct<
Type1, Type2 >::type > 
operator^ (const dimensioned< Type1 > &, const dimensioned< Type2 > &)
template<class Type, class Form, class Cmpt, int nCmpt>
dimensioned< typename crossProduct<
Type, Form >::type > 
operator^ (const dimensioned< Type > &, const VectorSpace< Form, Cmpt, nCmpt > &)
template<class Type, class Form, class Cmpt, int nCmpt>
dimensioned< typename crossProduct<
Form, Type >::type > 
operator^ (const VectorSpace< Form, Cmpt, nCmpt > &, const dimensioned< Type > &)
template<class Type1, class Type2>
dimensioned< typename innerProduct<
Type1, Type2 >::type > 
operator & (const dimensioned< Type1 > &, const dimensioned< Type2 > &)
template<class Type, class Form, class Cmpt, int nCmpt>
dimensioned< typename innerProduct<
Type, Form >::type > 
operator & (const dimensioned< Type > &, const VectorSpace< Form, Cmpt, nCmpt > &)
template<class Type, class Form, class Cmpt, int nCmpt>
dimensioned< typename innerProduct<
Form, Type >::type > 
operator & (const VectorSpace< Form, Cmpt, nCmpt > &, const dimensioned< Type > &)
template<class Type1, class Type2>
dimensioned< typename scalarProduct<
Type1, Type2 >::type > 
operator && (const dimensioned< Type1 > &, const dimensioned< Type2 > &)
template<class Type, class Form, class Cmpt, int nCmpt>
dimensioned< typename scalarProduct<
Type, Form >::type > 
operator && (const dimensioned< Type > &, const VectorSpace< Form, Cmpt, nCmpt > &)
template<class Type, class Form, class Cmpt, int nCmpt>
dimensioned< typename scalarProduct<
Form, Type >::type > 
operator && (const VectorSpace< Form, Cmpt, nCmpt > &, const dimensioned< Type > &)


Define Documentation

#define PRODUCT_OPERATOR product,
op,
opFunc   ) 
 

Value:

\
template<class Type1, class Type2>                                            \
dimensioned<typename product<Type1, Type2>::type>                             \
operator op(const dimensioned<Type1>&, const dimensioned<Type2>&);            \
                                                                              \
template<class Type, class Form, class Cmpt, int nCmpt>                       \
dimensioned<typename product<Type, Form>::type>                               \
operator op                                                                   \
(                                                                             \
    const dimensioned<Type>&,                                                 \
    const VectorSpace<Form,Cmpt,nCmpt>&                                       \
);                                                                            \
                                                                              \
template<class Type, class Form, class Cmpt, int nCmpt>                       \
dimensioned<typename product<Form, Type>::type>                               \
operator op                                                                   \
(                                                                             \
    const VectorSpace<Form,Cmpt,nCmpt>&,                                      \
    const dimensioned<Type>&                                                  \
);

Definition at line 223 of file dimensionedType.H.


Function Documentation

dimensioned<scalar> mag const dimensioned< Type > &   ) 
 

Referenced by cellModel::clone(), diagonalEdge::diagonalEdgeHash::diagonalEdgeHash(), faceEdge::faceEdgeHash::faceEdgeHash(), pyramidEdge::pyramidEdgeHash::pyramidEdgeHash(), parcel::Urel(), and wallPoint::valid().

dimensioned<scalar> magSqr const dimensioned< Type > &   ) 
 

Referenced by tetrahedron::mag(), and Foam::operator *().

dimensioned<Type> max const dimensioned< Type > &  ,
const dimensioned< Type > & 
 

dimensioned<Type> min const dimensioned< Type > &  ,
const dimensioned< Type > & 
 

dimensioned<typename innerProduct <Form, Type>::type> operator & const VectorSpace< Form, Cmpt, nCmpt > &  ,
const dimensioned< Type > & 
 

dimensioned<typename innerProduct <Type, Form>::type> operator & const dimensioned< Type > &  ,
const VectorSpace< Form, Cmpt, nCmpt > & 
 

dimensioned<typename innerProduct <Type1, Type2>::type> operator & const dimensioned< Type1 > &  ,
const dimensioned< Type2 > & 
 

dimensioned<typename scalarProduct <Form, Type>::type> operator && const VectorSpace< Form, Cmpt, nCmpt > &  ,
const dimensioned< Type > & 
 

dimensioned<typename scalarProduct <Type, Form>::type> operator && const dimensioned< Type > &  ,
const VectorSpace< Form, Cmpt, nCmpt > & 
 

dimensioned<typename scalarProduct <Type1, Type2>::type> operator && const dimensioned< Type1 > &  ,
const dimensioned< Type2 > & 
 

dimensioned<typename outerProduct <Form, Type>::type> operator * const VectorSpace< Form, Cmpt, nCmpt > &  ,
const dimensioned< Type > & 
 

dimensioned<typename outerProduct <Type, Form>::type> operator * const dimensioned< Type > &  ,
const VectorSpace< Form, Cmpt, nCmpt > & 
 

dimensioned<typename outerProduct <Type1, Type2>::type> operator * const dimensioned< Type1 > &  ,
const dimensioned< Type2 > & 
 

dimensioned<Type> operator * const dimensioned< scalar > &  ,
const dimensioned< Type > & 
 

dimensioned<Type> operator+ const dimensioned< Type > &  ,
const dimensioned< Type > & 
 

dimensioned<Type> operator- const dimensioned< Type > &  ,
const dimensioned< Type > & 
 

dimensioned<Type> operator- const dimensioned< Type > &   ) 
 

dimensioned<Type> operator/ const dimensioned< Type > &  ,
const dimensioned< scalar > & 
 

bool operator< const dimensioned< Type > &  ,
const dimensioned< Type > & 
 

Ostream& operator<< Ostream &  ,
const dimensioned< Type > & 
 

bool operator> const dimensioned< Type > &  ,
const dimensioned< Type > & 
 

Istream& operator>> Istream &  ,
dimensioned< Type > & 
 

dimensioned<typename crossProduct <Form, Type>::type> operator^ const VectorSpace< Form, Cmpt, nCmpt > &  ,
const dimensioned< Type > & 
 

dimensioned<typename crossProduct <Type, Form>::type> operator^ const dimensioned< Type > &  ,
const VectorSpace< Form, Cmpt, nCmpt > & 
 

dimensioned<typename crossProduct <Type1, Type2>::type> operator^ const dimensioned< Type1 > &  ,
const dimensioned< Type2 > & 
 

dimensioned<typename powProduct<Type, r>::type> pow const dimensioned< Type > &  ,
typename powProduct< Type, r >::type  = pTraits< typename powProduct< Type, r >::type >::zero
 

dimensioned<Type> scale const dimensioned< Type > &  ,
const dimensioned< Type > & 
 

dimensioned<typename outerProduct<Type, Type>::type> sqr const dimensioned< Type > &   ) 
 

Referenced by Foam::invariantI(), constTransport::kappa(), Foam::operator!=(), and Foam::pow().

For further information go to www.openfoam.org