File size: 7,018 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 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 | /*---------------------------------------------------------------------------*\
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration | Website: https://openfoam.org
\\ / A nd | Copyright (C) 2011-2023 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::VectorSpace
Description
Templated vector space.
Template arguments are the Form the vector space will be used to create,
the type of the elements and the number of elements.
SourceFiles
VectorSpaceI.H
VectorSpace.C
\*---------------------------------------------------------------------------*/
#ifndef VectorSpace_H
#define VectorSpace_H
#include "direction.H"
#include "scalar.H"
#include "word.H"
#include "zero.H"
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
namespace Foam
{
// Forward declaration of friend functions and operators
template<class Form, class Cmpt, direction Ncmpts> class VectorSpace;
template<class Form, class Cmpt, direction Ncmpts>
void writeEntry(Ostream& os, const VectorSpace<Form, Cmpt, Ncmpts>& value);
template<class Form, class Cmpt, direction Ncmpts>
Istream& operator>>
(
Istream&,
VectorSpace<Form, Cmpt, Ncmpts>&
);
template<class Form, class Cmpt, direction Ncmpts>
Ostream& operator<<
(
Ostream&,
const VectorSpace<Form, Cmpt, Ncmpts>&
);
// Helper to restrict templated methods to rank-0 primitives
template<class Type>
using EnableRank0 = typename std::enable_if<pTraits<Type>::rank == 0>::type;
/*---------------------------------------------------------------------------*\
Class VectorSpace Declaration
\*---------------------------------------------------------------------------*/
template<class Form, class Cmpt, direction Ncmpts>
class VectorSpace
{
public:
//- The components of this vector space
Cmpt v_[Ncmpts];
//- VectorSpace type
typedef VectorSpace<Form, Cmpt, Ncmpts> vsType;
//- Component type
typedef Cmpt cmptType;
// Static constants
//- Dimensionality of space
static const direction dim = 3;
//- Number of components in this vector space
static const direction nComponents = Ncmpts;
// VectorSpace currently defaults to a column-vector
// This will be removed when column-vector is introduced
// as a specialisation
static const direction mRows = Ncmpts;
static const direction nCols = 1;
// Static Data Members
static const char* const typeName;
static const char* const componentNames[];
static const Form zero;
static const Form one;
static const Form max;
static const Form min;
static const Form rootMax;
static const Form rootMin;
static const Form nan;
// Sub-Block Classes
//- Const sub-block type
template
<
class SubVector,
direction BStart
>
class ConstBlock
{
const vsType& vs_;
public:
//- Number of components in this vector space
static const direction nComponents = SubVector::nComponents;
//- Construct for a given vector
inline ConstBlock(const vsType& vs);
//- [i] const element access operator
inline const Cmpt& operator[](const direction i) const;
//- (i, 0) const element access operator
inline const Cmpt& operator()
(
const direction i,
const direction
) const;
};
// Constructors
//- Construct null
inline VectorSpace();
//- Construct initialised to zero
inline VectorSpace(const Foam::zero);
//- Construct from Istream
VectorSpace(Istream&);
//- Construct as copy of a VectorSpace with the same size
template<class Form2, class Cmpt2>
inline explicit VectorSpace(const VectorSpace<Form2, Cmpt2, Ncmpts>&);
// Member Functions
//- Return the number of elements in the VectorSpace = Ncmpts.
inline static direction size();
inline const Cmpt& component(const direction) const;
inline Cmpt& component(const direction);
inline void component(Cmpt&, const direction) const;
inline void replace(const direction, const Cmpt&);
//- Return a VectorSpace with all elements = s
inline static Form uniform(const Cmpt& s);
template<class SubVector, direction BStart>
inline const ConstBlock<SubVector, BStart> block() const;
// Member Operators
inline const Cmpt& operator[](const direction) const;
inline Cmpt& operator[](const direction);
inline void operator+=(const VectorSpace<Form, Cmpt, Ncmpts>&);
inline void operator-=(const VectorSpace<Form, Cmpt, Ncmpts>&);
inline void operator=(const Foam::zero);
template<class Type, class Enable = EnableRank0<Type>>
inline void operator*=(const Type);
template<class Type, class Enable = EnableRank0<Type>>
inline void operator/=(const Type);
// IOstream Operators
friend Istream& operator>> <Form, Cmpt, Ncmpts>
(
Istream&,
VectorSpace<Form, Cmpt, Ncmpts>&
);
friend Ostream& operator<< <Form, Cmpt, Ncmpts>
(
Ostream&,
const VectorSpace<Form, Cmpt, Ncmpts>&
);
};
// * * * * * * * * * * * * * * Global functions * * * * * * * * * * * * * * //
//- Return a string representation of a VectorSpace
template<class Form, class Cmpt, direction Ncmpts>
word name(const VectorSpace<Form, Cmpt, Ncmpts>&);
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
} // End namespace Foam
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
#include "VectorSpaceI.H"
#ifdef NoRepository
#include "VectorSpace.C"
#endif
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
#endif
// ************************************************************************* //
|