This repository has been archived on 2023-11-20. You can view files and clone it, but cannot push or open issues or pull requests.
foam-extend4.1-coherent-io/src/OpenFOAM/primitives/DiagTensor/DiagTensor.H

123 lines
3.4 KiB
C
Raw Normal View History

/*---------------------------------------------------------------------------*\
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration |
\\ / A nd | Copyright held by original author
\\/ 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 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
Class
Foam::DiagTensor
Description
Templated 3D DiagTensor derived from VectorSpace adding construction from
3 components, element access using xx(), yy() and zz() member functions and
the inner-product (dot-product) and outer-product operators.
SourceFiles
DiagTensorI.H
\*---------------------------------------------------------------------------*/
#ifndef DiagTensor_H
#define DiagTensor_H
#include "Tensor.H"
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
namespace Foam
{
/*---------------------------------------------------------------------------*\
Class DiagTensor Declaration
\*---------------------------------------------------------------------------*/
template <class Cmpt>
class DiagTensor
:
public VectorSpace<DiagTensor<Cmpt>, Cmpt, 3>
{
public:
// Member constants
enum
{
rank = 2 // Rank of DiagTensor is 2
};
// Static data members
static const char* const typeName;
static const char* componentNames[];
static const DiagTensor zero;
static const DiagTensor one;
//- Component labeling enumeration
enum components { XX, YY, ZZ };
// Constructors
//- Construct null
inline DiagTensor();
//- Construct given VectorSpace
inline DiagTensor(const VectorSpace<DiagTensor<Cmpt>, Cmpt, 3>&);
//- Construct given three components
inline DiagTensor(const Cmpt& txx, const Cmpt& tyy, const Cmpt& tzz);
//- Construct from Istream
inline DiagTensor(Istream&);
// Member Functions
// Access
inline const Cmpt& xx() const;
inline const Cmpt& yy() const;
inline const Cmpt& zz() const;
inline Cmpt& xx();
inline Cmpt& yy();
inline Cmpt& zz();
};
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
} // End namespace Foam
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
// Include inline implementations
#include "DiagTensorI.H"
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
#endif
// ************************************************************************* //