Files
openfoam/src/OpenFOAM/primitives/SymmTensor/SymmTensor.H
Henry Weller 2027059b63 src/OpenFOAM: changed template rank type from int to Foam::direction
Foam::direction is an unsigned type which makes it easier for the
compiler to pickup and report errors in the instantiation of
VectorSpaces and associated types.
2016-03-09 10:10:28 +00:00

156 lines
4.2 KiB
C++

/*---------------------------------------------------------------------------*\
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration |
\\ / A nd | Copyright (C) 2011-2016 OpenFOAM Foundation
\\/ M anipulation |
-------------------------------------------------------------------------------
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 3 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, see <http://www.gnu.org/licenses/>.
Class
Foam::SymmTensor
Description
Templated 3D symmetric tensor derived from VectorSpace adding construction
from 6 components, element access using xx(), xy() etc. member functions
and the inner-product (dot-product) and outer-product of two Vectors
(tensor-product) operators.
SourceFiles
SymmTensorI.H
\*---------------------------------------------------------------------------*/
#ifndef SymmTensor_H
#define SymmTensor_H
#include "VectorSpace.H"
#include "SphericalTensor.H"
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
namespace Foam
{
/*---------------------------------------------------------------------------*\
Class SymmTensor Declaration
\*---------------------------------------------------------------------------*/
template<class Cmpt>
class SymmTensor
:
public VectorSpace<SymmTensor<Cmpt>, Cmpt, 6>
{
public:
//- Equivalent type of labels used for valid component indexing
typedef SymmTensor<label> labelType;
// Member constants
//- Rank of SymmTensor is 2
static const direction rank = 2;
// Static data members
static const SymmTensor I;
//- Component labeling enumeration
enum components { XX, XY, XZ, YY, YZ, ZZ };
// Constructors
//- Construct null
inline SymmTensor();
//- Construct given VectorSpace of the same rank
template<class Cmpt2>
inline SymmTensor(const VectorSpace<SymmTensor<Cmpt2>, Cmpt2, 6>&);
//- Construct given SphericalTensor
inline SymmTensor(const SphericalTensor<Cmpt>&);
//- Construct given the six components
inline SymmTensor
(
const Cmpt txx, const Cmpt txy, const Cmpt txz,
const Cmpt tyy, const Cmpt tyz,
const Cmpt tzz
);
//- Construct from Istream
SymmTensor(Istream&);
// Member Functions
// Access
inline const Cmpt& xx() const;
inline const Cmpt& xy() const;
inline const Cmpt& xz() const;
inline const Cmpt& yy() const;
inline const Cmpt& yz() const;
inline const Cmpt& zz() const;
inline Cmpt& xx();
inline Cmpt& xy();
inline Cmpt& xz();
inline Cmpt& yy();
inline Cmpt& yz();
inline Cmpt& zz();
//- Transpose
inline const SymmTensor<Cmpt>& T() const;
// Member Operators
//- Construct given SphericalTensor
inline void operator=(const SphericalTensor<Cmpt>&);
};
template<class Cmpt>
class symmTypeOfRank<Cmpt, 2>
{
public:
typedef SymmTensor<Cmpt> type;
};
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
} // End namespace Foam
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
// Include inline implementations
#include "SymmTensorI.H"
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
#endif
// ************************************************************************* //