mirror of
https://develop.openfoam.com/Development/openfoam.git
synced 2025-12-28 03:37:59 +00:00
153 lines
3.9 KiB
C++
153 lines
3.9 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::Vector
|
|
|
|
Description
|
|
Templated 3D Vector derived from VectorSpace adding construction from
|
|
3 components, element access using x(), y() and z() member functions and
|
|
the inner-product (dot-product) and cross product operators.
|
|
|
|
A centre() member function which returns the Vector for which it is called
|
|
is defined so that point which is a typedef to Vector\<scalar\> behaves as
|
|
other shapes in the shape hierachy.
|
|
|
|
SourceFiles
|
|
VectorI.H
|
|
|
|
\*---------------------------------------------------------------------------*/
|
|
|
|
#ifndef Vector_H
|
|
#define Vector_H
|
|
|
|
#include "VectorSpace.H"
|
|
|
|
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
|
|
|
|
namespace Foam
|
|
{
|
|
|
|
template<class T> class List;
|
|
|
|
/*---------------------------------------------------------------------------*\
|
|
Class Vector Declaration
|
|
\*---------------------------------------------------------------------------*/
|
|
|
|
template<class Cmpt>
|
|
class Vector
|
|
:
|
|
public VectorSpace<Vector<Cmpt>, Cmpt, 3>
|
|
{
|
|
|
|
public:
|
|
|
|
//- Equivalent type of labels used for valid component indexing
|
|
typedef Vector<label> labelType;
|
|
|
|
|
|
// Member constants
|
|
|
|
enum
|
|
{
|
|
rank = 1 // Rank of Vector is 1
|
|
};
|
|
|
|
|
|
//- Component labeling enumeration
|
|
enum components { X, Y, Z };
|
|
|
|
|
|
// Constructors
|
|
|
|
//- Construct null
|
|
inline Vector();
|
|
|
|
//- Construct given VectorSpace of the same rank
|
|
template<class Cmpt2>
|
|
inline Vector(const VectorSpace<Vector<Cmpt2>, Cmpt2, 3>&);
|
|
|
|
//- Construct given three components
|
|
inline Vector(const Cmpt& vx, const Cmpt& vy, const Cmpt& vz);
|
|
|
|
//- Construct from Istream
|
|
inline Vector(Istream&);
|
|
|
|
|
|
// Member Functions
|
|
|
|
// Access
|
|
|
|
inline const Cmpt& x() const;
|
|
inline const Cmpt& y() const;
|
|
inline const Cmpt& z() const;
|
|
|
|
inline Cmpt& x();
|
|
inline Cmpt& y();
|
|
inline Cmpt& z();
|
|
|
|
//- Return *this (used for point which is a typedef to Vector<scalar>.
|
|
inline const Vector<Cmpt>& centre
|
|
(
|
|
const Foam::List<Vector<Cmpt>>&
|
|
) const;
|
|
|
|
|
|
// Member Operators
|
|
|
|
inline void operator=(const Foam::zero);
|
|
};
|
|
|
|
|
|
template<class Cmpt>
|
|
class typeOfRank<Cmpt, 1>
|
|
{
|
|
public:
|
|
|
|
typedef Vector<Cmpt> type;
|
|
};
|
|
|
|
|
|
template<class Cmpt>
|
|
class symmTypeOfRank<Cmpt, 1>
|
|
{
|
|
public:
|
|
|
|
typedef Vector<Cmpt> type;
|
|
};
|
|
|
|
|
|
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
|
|
|
|
} // End namespace Foam
|
|
|
|
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
|
|
|
|
#include "VectorI.H"
|
|
|
|
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
|
|
|
|
#endif
|
|
|
|
// ************************************************************************* //
|