File size: 3,412 Bytes
5a600cf | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 | /*---------------------------------------------------------------------------*\
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration | Website: https://openfoam.org
\\ / A nd | Copyright (C) 2011-2021 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::Vector2D
Description
Templated 2D Vector derived from VectorSpace adding construction from
2 components, element access using x() and y() member functions and
the inner-product (dot-product).
SourceFiles
Vector2DI.H
\*---------------------------------------------------------------------------*/
#ifndef Vector2D_H
#define Vector2D_H
#include "VectorSpace.H"
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
namespace Foam
{
/*---------------------------------------------------------------------------*\
Class Vector2D Declaration
\*---------------------------------------------------------------------------*/
template<class Cmpt>
class Vector2D
:
public VectorSpace<Vector2D<Cmpt>, Cmpt, 2>
{
public:
//- Equivalent type of labels used for valid component indexing
typedef Vector2D<label> labelType;
// Member constants
//- Rank of Vector2D is 1
static const direction rank = 1;
//- Component labeling enumeration
enum components { X, Y };
// Constructors
//- Construct null
inline Vector2D();
//- Construct initialised to zero
inline Vector2D(const Foam::zero);
//- Construct given VectorSpace
inline Vector2D(const VectorSpace<Vector2D<Cmpt>, Cmpt, 2>&);
//- Construct given two components
inline Vector2D(const Cmpt& vx, const Cmpt& vy);
//- Construct from Istream
inline Vector2D(Istream&);
// Member Functions
// Access
inline const Cmpt& x() const;
inline const Cmpt& y() const;
inline Cmpt& x();
inline Cmpt& y();
// Operators
//- Perp dot product (dot product with perpendicular vector)
inline scalar perp(const Vector2D<Cmpt>& b) const;
};
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
} // End namespace Foam
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
// Include inline implementations
#include "Vector2DI.H"
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
#endif
// ************************************************************************* //
|