mirror of
https://develop.openfoam.com/Development/openfoam.git
synced 2025-11-28 03:28:01 +00:00
- background: for some application it can be useful to have fully
sorted points. i.e., sorted by x, followed by y, followed by z.
The default VectorSpace 'operator<' compares *all*
components. This is seen by the following comparisons
1. a = (-2.2 -3.3 -4.4)
b = (-1.1 -2.2 3.3)
(a < b) : True
Each 'a' component is less than each 'b' component
2. a = (-2.2 -3.3 -4.4)
b = (-2.2 3.3 4.4)
(a < b) : False
The a.x() is not less than b.x()
The static definitions 'less_xyz', 'less_yzx', 'less_zxy'
instead use comparison of the next components as tie breakers
(like a lexicographic sort).
- same type of definition that Pair and Tuple2 use.
a = (-2.2 -3.3 -4.4)
b = (-2.2 3.3 4.4)
vector::less_xyz(a, b) : True
The a.x() == b.x(), but a.y() < b.y()
They can be used directly as comparators:
pointField points = ...;
std::sort(points.begin(), points.end(), vector::less_zxy);
ENH: make VectorSpace named access methods noexcept.
Since the addressing range is restricted to enumerated offsets
(eg, X/Y/Z) into storage, always remains in-range.
Possible to make constexpr with future C++ versions.
STYLE: VectorSpace 'operator>' defined using 'operator<'
- standard rewriting rule
133 lines
3.6 KiB
C++
133 lines
3.6 KiB
C++
/*---------------------------------------------------------------------------*\
|
|
========= |
|
|
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
|
|
\\ / O peration |
|
|
\\ / A nd | www.openfoam.com
|
|
\\/ M anipulation |
|
|
-------------------------------------------------------------------------------
|
|
Copyright (C) 2016 OpenFOAM Foundation
|
|
-------------------------------------------------------------------------------
|
|
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::RowVector
|
|
|
|
Description
|
|
Templated 3D row-vector derived from MatrixSpace adding construction from
|
|
3 components and element access using x(), y() and z().
|
|
|
|
SourceFiles
|
|
RowVectorI.H
|
|
|
|
\*---------------------------------------------------------------------------*/
|
|
|
|
#ifndef RowVector_H
|
|
#define RowVector_H
|
|
|
|
#include "MatrixSpace.H"
|
|
#include "Vector.H"
|
|
|
|
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
|
|
|
|
namespace Foam
|
|
{
|
|
|
|
/*---------------------------------------------------------------------------*\
|
|
Class RowVector Declaration
|
|
\*---------------------------------------------------------------------------*/
|
|
|
|
template<class Cmpt>
|
|
class RowVector
|
|
:
|
|
public MatrixSpace<RowVector<Cmpt>, Cmpt, 1, 3>
|
|
{
|
|
|
|
public:
|
|
|
|
//- Equivalent type of labels used for valid component indexing
|
|
typedef RowVector<label> labelType;
|
|
|
|
|
|
//- Component labeling enumeration
|
|
enum components { X, Y, Z };
|
|
|
|
|
|
// Constructors
|
|
|
|
//- Default construct
|
|
RowVector() = default;
|
|
|
|
//- Construct initialized to zero
|
|
inline RowVector(const Foam::zero);
|
|
|
|
//- Construct given VectorSpace of the same rank
|
|
template<class Cmpt2>
|
|
inline RowVector(const MatrixSpace<RowVector<Cmpt2>, Cmpt2, 1, 3>&);
|
|
|
|
//- Construct given three components
|
|
inline RowVector(const Cmpt& rvx, const Cmpt& rvy, const Cmpt& rvz);
|
|
|
|
//- Construct from Istream
|
|
inline explicit RowVector(Istream&);
|
|
|
|
|
|
// Member Functions
|
|
|
|
// Component Access
|
|
|
|
const Cmpt& x() const noexcept { return this->v_[X]; }
|
|
const Cmpt& y() const noexcept { return this->v_[Y]; }
|
|
const Cmpt& z() const noexcept { return this->v_[Z]; }
|
|
|
|
Cmpt& x() noexcept { return this->v_[X]; }
|
|
Cmpt& y() noexcept { return this->v_[Y]; }
|
|
Cmpt& z() noexcept { return this->v_[Z]; }
|
|
};
|
|
|
|
|
|
template<class Cmpt>
|
|
class typeOfTranspose<Cmpt, Vector<Cmpt>>
|
|
{
|
|
public:
|
|
|
|
typedef RowVector<Cmpt> type;
|
|
};
|
|
|
|
|
|
template<class Cmpt>
|
|
class typeOfTranspose<Cmpt, RowVector<Cmpt>>
|
|
{
|
|
public:
|
|
|
|
typedef Vector<Cmpt> type;
|
|
};
|
|
|
|
|
|
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
|
|
|
|
} // End namespace Foam
|
|
|
|
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
|
|
|
|
#include "RowVectorI.H"
|
|
|
|
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
|
|
|
|
#endif
|
|
|
|
// ************************************************************************* //
|