src/OpenFOAM/primitives/spatialVectorAlgebra: New classes to support spatial vector algebra

Based on definitions in chapter 2 of the book:
    Featherstone, R. (2008).
    Rigid body dynamics algorithms.
    Springer.

This work is sponsored by Carnegie Wave Energy Ltd
This commit is contained in:
Henry Weller
2016-03-15 18:14:03 +00:00
parent ffa9d235ea
commit 662f123ad8
15 changed files with 1530 additions and 0 deletions

View File

@ -0,0 +1,176 @@
/*---------------------------------------------------------------------------*\
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration |
\\ / A nd | Copyright (C) 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::SpatialTensor
Description
Templated 3D spatial tensor derived from MatrixSpace used to represent
transformations of spatial vectors and the angular and linear inertia of
rigid bodies.
Reference:
\verbatim
Featherstone, R. (2008).
Rigid body dynamics algorithms.
Springer.
\endverbatim
SourceFiles
SpatialTensorI.H
SeeAlso
Foam::MatrixSpace
Foam::Tensor
Foam::SpatialVector
\*---------------------------------------------------------------------------*/
#ifndef SpatialTensor_H
#define SpatialTensor_H
#include "Tensor.H"
#include "SpatialVector.H"
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
namespace Foam
{
/*---------------------------------------------------------------------------*\
Class SpatialTensor Declaration
\*---------------------------------------------------------------------------*/
template<class Cmpt>
class SpatialTensor
:
public MatrixSpace<SpatialTensor<Cmpt>, Cmpt, 6, 6>
{
public:
// Member constants
//- Rank of Tensor is 2
static const direction rank = 2;
// Static data members
//- Identity matrix for square matrices
static const SpatialTensor I;
// Constructors
//- Construct null
inline SpatialTensor();
//- Construct initialized to zero
inline explicit SpatialTensor(const Foam::zero);
//- Construct given MatrixSpace of the same rank
inline SpatialTensor(const typename SpatialTensor::msType&);
//- Construct given 36 components
inline SpatialTensor
(
const Cmpt& t00, const Cmpt& t01, const Cmpt& t02,
const Cmpt& t03, const Cmpt& t04, const Cmpt& t05,
const Cmpt& t10, const Cmpt& t11, const Cmpt& t12,
const Cmpt& t13, const Cmpt& t14, const Cmpt& t15,
const Cmpt& t20, const Cmpt& t21, const Cmpt& t22,
const Cmpt& t23, const Cmpt& t24, const Cmpt& t25,
const Cmpt& t30, const Cmpt& t31, const Cmpt& t32,
const Cmpt& t33, const Cmpt& t34, const Cmpt& t35,
const Cmpt& t40, const Cmpt& t41, const Cmpt& t42,
const Cmpt& t43, const Cmpt& t44, const Cmpt& t45,
const Cmpt& t50, const Cmpt& t51, const Cmpt& t52,
const Cmpt& t53, const Cmpt& t54, const Cmpt& t55
);
//- Construct from Istream
inline SpatialTensor(Istream&);
// Member Operators
inline void operator=(const Foam::zero);
};
template<class Cmpt>
class typeOfTranspose<Cmpt, SpatialTensor<Cmpt>>
{
public:
typedef SpatialTensor<Cmpt> type;
};
template<class Cmpt>
class typeOfOuterProduct<Cmpt, SpatialVector<Cmpt>, SpatialVector<Cmpt>>
{
public:
typedef SpatialTensor<Cmpt> type;
};
template<class Cmpt>
class typeOfInnerProduct<Cmpt, SpatialTensor<Cmpt>, SpatialVector<Cmpt>>
{
public:
typedef SpatialVector<Cmpt> type;
};
template<class Cmpt>
class typeOfInnerProduct<Cmpt, SpatialTensor<Cmpt>, SpatialTensor<Cmpt>>
{
public:
typedef SpatialTensor<Cmpt> type;
};
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
} // End namespace Foam
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
// Include inline implementations
#include "SpatialTensorI.H"
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
#endif
// ************************************************************************* //

View File

@ -0,0 +1,132 @@
/*---------------------------------------------------------------------------*\
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration |
\\ / A nd | Copyright (C) 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/>.
\*---------------------------------------------------------------------------*/
// * * * * * * * * * * * * * * * * Constructors * * * * * * * * * * * * * * //
template<class Cmpt>
inline Foam::SpatialTensor<Cmpt>::SpatialTensor()
{}
template<class Cmpt>
inline Foam::SpatialTensor<Cmpt>::SpatialTensor(const Foam::zero z)
:
SpatialTensor::msType(z)
{}
template<class Cmpt>
inline Foam::SpatialTensor<Cmpt>::SpatialTensor
(
const typename SpatialTensor::msType& ms
)
:
SpatialTensor::msType(ms)
{}
template<class Cmpt>
inline Foam::SpatialTensor<Cmpt>::SpatialTensor
(
const Cmpt& t00, const Cmpt& t01, const Cmpt& t02,
const Cmpt& t03, const Cmpt& t04, const Cmpt& t05,
const Cmpt& t10, const Cmpt& t11, const Cmpt& t12,
const Cmpt& t13, const Cmpt& t14, const Cmpt& t15,
const Cmpt& t20, const Cmpt& t21, const Cmpt& t22,
const Cmpt& t23, const Cmpt& t24, const Cmpt& t25,
const Cmpt& t30, const Cmpt& t31, const Cmpt& t32,
const Cmpt& t33, const Cmpt& t34, const Cmpt& t35,
const Cmpt& t40, const Cmpt& t41, const Cmpt& t42,
const Cmpt& t43, const Cmpt& t44, const Cmpt& t45,
const Cmpt& t50, const Cmpt& t51, const Cmpt& t52,
const Cmpt& t53, const Cmpt& t54, const Cmpt& t55
)
{
this->v_[0] = t00;
this->v_[1] = t01;
this->v_[2] = t02;
this->v_[3] = t03;
this->v_[4] = t04;
this->v_[5] = t05;
this->v_[6] = t10;
this->v_[7] = t11;
this->v_[8] = t12;
this->v_[9] = t13;
this->v_[10] = t14;
this->v_[11] = t15;
this->v_[12] = t20;
this->v_[13] = t21;
this->v_[14] = t22;
this->v_[15] = t23;
this->v_[16] = t24;
this->v_[17] = t25;
this->v_[18] = t30;
this->v_[19] = t31;
this->v_[20] = t32;
this->v_[21] = t33;
this->v_[22] = t34;
this->v_[23] = t35;
this->v_[24] = t40;
this->v_[25] = t41;
this->v_[26] = t42;
this->v_[27] = t43;
this->v_[28] = t44;
this->v_[29] = t45;
this->v_[30] = t50;
this->v_[31] = t51;
this->v_[32] = t52;
this->v_[33] = t53;
this->v_[34] = t54;
this->v_[35] = t55;
}
template<class Cmpt>
inline Foam::SpatialTensor<Cmpt>::SpatialTensor(Istream& is)
:
SpatialTensor::msType(is)
{}
// * * * * * * * * * * * * * * * Member Functions * * * * * * * * * * * * * //
template<class Cmpt>
inline void Foam::SpatialTensor<Cmpt>::operator=(const Foam::zero z)
{
SpatialTensor::msType::operator=(z);
}
// ************************************************************************* //

View File

@ -0,0 +1,88 @@
/*---------------------------------------------------------------------------*\
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration |
\\ / A nd | Copyright (C) 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/>.
\*---------------------------------------------------------------------------*/
#include "spatialTensor.H"
// * * * * * * * * * * * * * * Static Data Members * * * * * * * * * * * * * //
template<>
const char* const Foam::spatialTensor::vsType::typeName = "spatialTensor";
template<>
const char* const Foam::spatialTensor::vsType::componentNames[] =
{
"Exx", "Exy", "Exz", "Erxx", "Erxy", "Erxz",
"Eyx", "Eyy", "Eyz", "Eryx", "Eryy", "Eryz",
"Ezx", "Ezy", "Ezz", "Erzx", "Erzy", "Erzz"
"Erxx", "Erxy", "Erxz", "Exx", "Exy", "Exz",
"Eryx", "Eryy", "Eryz", "Eyx", "Eyy", "Eyz",
"Erzx", "Erzy", "Erzz", "Ezx", "Ezy", "Ezz"
};
template<>
const Foam::spatialTensor Foam::spatialTensor::vsType::zero
(
Foam::spatialTensor::uniform(0)
);
template<>
const Foam::spatialTensor Foam::spatialTensor::vsType::one
(
spatialTensor::uniform(1)
);
template<>
const Foam::spatialTensor Foam::spatialTensor::vsType::max
(
spatialTensor::uniform(VGREAT)
);
template<>
const Foam::spatialTensor Foam::spatialTensor::vsType::min
(
spatialTensor::uniform(-VGREAT)
);
template<>
const Foam::spatialTensor Foam::spatialTensor::vsType::rootMax
(
spatialTensor::uniform(ROOTVGREAT)
);
template<>
const Foam::spatialTensor Foam::spatialTensor::vsType::rootMin
(
spatialTensor::uniform(-ROOTVGREAT)
);
template<>
const Foam::spatialTensor Foam::spatialTensor::I
(
Foam::spatialTensor::identity()
);
// ************************************************************************* //

View File

@ -0,0 +1,62 @@
/*---------------------------------------------------------------------------*\
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration |
\\ / A nd | Copyright (C) 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/>.
Typedef
Foam::spatialTensor
Description
SpatialTensor of scalars.
SourceFiles
spatialTensor.C
\*---------------------------------------------------------------------------*/
#ifndef spatialTensor_H
#define spatialTensor_H
#include "SpatialTensor.H"
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
namespace Foam
{
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
typedef SpatialTensor<scalar> spatialTensor;
//- Data associated with spatialTensor type are contiguous
template<>
inline bool contiguous<spatialTensor>() {return true;}
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
} // End namespace Foam
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
#endif
// ************************************************************************* //