Commit ecbaf732 authored by Mark Olesen's avatar Mark Olesen

STYLE: spelling, default destructor

parent f6dce11a
......@@ -25,7 +25,8 @@ Class
Foam::entrainmentModels::ErrosionEnergy
Description
An entrainment model following the errosion energy apporach (see Rauter et al. 2016).
An entrainment model following the errosion energy apporach
(see Rauter et al. 2016).
SourceFiles
Erosionenergy.C
......@@ -68,12 +69,12 @@ class Erosionenergy
{
// Private data
//Specific erroision energy parameter e_b
//- Specific erosion energy parameter e_b
dimensionedScalar eb_;
//Pointer to the gravitation fields
const areaVectorField &gs_;
const areaScalarField &gn_;
//- Reference to the gravitation fields
const areaVectorField& gs_;
const areaScalarField& gn_;
public:
......@@ -83,7 +84,7 @@ public:
// Constructors
//- construct from components
//- Construct from components
Erosionenergy
(
const word& name,
......@@ -96,10 +97,8 @@ public:
);
// Destructor
virtual ~Erosionenergy()
{}
//- Destructor
virtual ~Erosionenergy() = default;
// Member Functions
......
......@@ -50,7 +50,6 @@ Author
#include "faMatrices.H"
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
namespace Foam
......@@ -68,7 +67,7 @@ class Front
{
// Private data
//Height threshold
//- Height threshold
dimensionedScalar htrigger_;
......@@ -85,18 +84,16 @@ public:
(
const word& name,
const dictionary& frictionProperties,
const areaVectorField &Us,
const areaScalarField &h,
const areaScalarField &hentrain,
const areaScalarField &pb,
const areaVectorField &tau
const areaVectorField& Us,
const areaScalarField& h,
const areaScalarField& hentrain,
const areaScalarField& pb,
const areaVectorField& tau
);
// Destructor
virtual ~Front()
{}
//- Destructor
virtual ~Front() = default;
// Member Functions
......
......@@ -68,18 +68,18 @@ class IsslerFC
{
// Private data
//Maximum shear stress tau_c
//- Maximum shear stress tau_c
dimensionedScalar tauc_;
//Kinetic Theory mu
//- Kinetic Theory mu
dimensionedScalar mu_;
//Kinetic Theory K
//- Kinetic Theory K
dimensionedScalar K_;
//Pointer to the gravitation fields
const areaVectorField &gs_;
const areaScalarField &gn_;
//- Reference to the gravitation fields
const areaVectorField& gs_;
const areaScalarField& gn_;
public:
......@@ -89,23 +89,21 @@ public:
// Constructors
//- construct from components
//- Construct from components
IsslerFC
(
const word& name,
const dictionary& frictionProperties,
const areaVectorField &Us,
const areaScalarField &h,
const areaScalarField &hentrain,
const areaScalarField &pb,
const areaVectorField &tau
const areaVectorField& Us,
const areaScalarField& h,
const areaScalarField& hentrain,
const areaScalarField& pb,
const areaVectorField& tau
);
// Destructor
virtual ~IsslerFC()
{}
//- Destructor
virtual ~IsslerFC() = default;
// Member Functions
......
......@@ -68,13 +68,13 @@ class Medina
{
// Private data
//Cohesion of the basal material at bottom
//- Cohesion of the basal material at bottom
dimensionedScalar tauc_;
//Friction coefficient tan(phi) of the basal material
//- Friction coefficient tan(phi) of the basal material
dimensionedScalar mu_;
//Pointer to the gravitation fields
//- Reference to the gravitation fields
const areaVectorField &gs_;
const areaScalarField &gn_;
......@@ -99,10 +99,8 @@ public:
);
// Destructor
virtual ~Medina()
{}
//- Destructor
virtual ~Medina() = default;
// Member Functions
......
......@@ -74,9 +74,9 @@ class Stopingprofile
//Formfactor for deposition curve
dimensionedScalar ad_;
//Pointer to the gravitation fields
const areaVectorField &gs_;
const areaScalarField &gn_;
//- Reference to the gravitation fields
const areaVectorField& gs_;
const areaScalarField& gn_;
public:
......@@ -86,22 +86,21 @@ public:
// Constructors
//- construct from components
//- Construct from components
Stopingprofile
(const word& name,
(
const word& name,
const dictionary& frictionProperties,
const areaVectorField &Us,
const areaScalarField &h,
const areaScalarField &hentrain,
const areaScalarField &pb,
const areaVectorField &tau
const areaVectorField& Us,
const areaScalarField& h,
const areaScalarField& hentrain,
const areaScalarField& pb,
const areaVectorField& tau
);
// Destructor
virtual ~Stopingprofile()
{}
//- Destructor
virtual ~Stopingprofile() = default;
// Member Functions
......
......@@ -66,44 +66,43 @@ namespace Foam
class depositionModel
{
protected:
// Protected data
word name_;
dictionary depositionProperties_;
dictionary depositionProperties_;
//The density
//- The density
dimensionedScalar rho_;
//Pointer to the surface velocity field
//- Reference to the surface velocity field
const areaVectorField &Us_;
//Pointer to the flow height field
//- Reference to the flow height field
const areaScalarField &h_;
//Pointer to the cover height field
//- Reference to the cover height field
const areaScalarField &hentrain_;
//Pointer to the basal pressure field
//- Reference to the basal pressure field
const areaScalarField &pb_;
//Pointer to the bottom stress field
//- Reference to the bottom stress field
const areaVectorField &tau_;
//Sink term
//- Sink term
mutable areaScalarField Sd_;
// Private Member Functions
//- Disallow copy construct
depositionModel(const depositionModel&);
depositionModel(const depositionModel&) = delete;
//- Disallow default bitwise assignment
void operator=(const depositionModel&);
void operator=(const depositionModel&) = delete;
public:
......@@ -123,11 +122,11 @@ public:
(
const word& name,
const dictionary& depositionProperties,
const areaVectorField &Us,
const areaScalarField &h,
const areaScalarField &hentrain,
const areaScalarField &pb,
const areaVectorField &tau
const areaVectorField& Us,
const areaScalarField& h,
const areaScalarField& hentrain,
const areaScalarField& pb,
const areaVectorField& tau
),
(name, depositionProperties, Us, h, hentrain, pb, tau)
);
......@@ -141,11 +140,11 @@ public:
(
const word& name,
const dictionary& depositionProperties,
const areaVectorField &Us,
const areaScalarField &h,
const areaScalarField &hentrain,
const areaScalarField &pb,
const areaVectorField &tau
const areaVectorField& Us,
const areaScalarField& h,
const areaScalarField& hentrain,
const areaScalarField& pb,
const areaVectorField& tau
);
......@@ -153,20 +152,19 @@ public:
//- Construct from components
depositionModel
(const word& name,
(
const word& name,
const dictionary& depositionProperties,
const areaVectorField &Us,
const areaScalarField &h,
const areaScalarField &hentrain,
const areaScalarField &pb,
const areaVectorField &tau
const areaVectorField& Us,
const areaScalarField& h,
const areaScalarField& hentrain,
const areaScalarField& pb,
const areaVectorField& tau
);
// Destructor
virtual ~depositionModel()
{}
//- Destructor
virtual ~depositionModel() = default;
// Member Functions
......
......@@ -21,8 +21,6 @@ License
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::depositionModel::depositionOff
......@@ -49,7 +47,6 @@ Author
#include "faMatrices.H"
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
namespace Foam
......@@ -58,7 +55,7 @@ namespace depositionModels
{
/*---------------------------------------------------------------------------*\
Class Erosionenergy Declaration
Class depositionOff Declaration
\*---------------------------------------------------------------------------*/
class depositionOff
......@@ -80,18 +77,16 @@ public:
(
const word& name,
const dictionary& frictionProperties,
const areaVectorField &Us,
const areaScalarField &h,
const areaScalarField &hentrain,
const areaScalarField &pb,
const areaVectorField &tau
const areaVectorField& Us,
const areaScalarField& h,
const areaScalarField& hentrain,
const areaScalarField& pb,
const areaVectorField& tau
);
// Destructor
virtual ~depositionOff()
{}
//- Destructor
virtual ~depositionOff() = default;
// Member Functions
......
......@@ -74,35 +74,35 @@ protected:
word name_;
dictionary entrainmentProperties_;
//The density
//- The density
dimensionedScalar rho_;
//Pointer to the surface velocity field
//- Reference to the surface velocity field
const areaVectorField &Us_;
//Pointer to the flow height field
//- Reference to the flow height field
const areaScalarField &h_;
//Pointer to the cover height field
//- Reference to the cover height field
const areaScalarField &hentrain_;
//Pointer to the basal pressure field
const areaScalarField &pb_;
//- Reference to the basal pressure field
const areaScalarField& pb_;
//Pointer to the bottom stress field
const areaVectorField &tau_;
//- Reference to the bottom stress field
const areaVectorField& tau_;
//Source term
//- Source term
mutable areaScalarField Sm_;
// Private Member Functions
//- Disallow copy construct
entrainmentModel(const entrainmentModel&);
entrainmentModel(const entrainmentModel&) = delete;
//- Disallow default bitwise assignment
void operator=(const entrainmentModel&);
void operator=(const entrainmentModel&) = delete;
public:
......@@ -152,26 +152,25 @@ public:
//- Construct from components
entrainmentModel
(const word& name,
(
const word& name,
const dictionary& entrainmentProperties,
const areaVectorField &Us,
const areaScalarField &h,
const areaScalarField &hentrain,
const areaScalarField &pb,
const areaVectorField &tau
const areaVectorField& Us,
const areaScalarField& h,
const areaScalarField& hentrain,
const areaScalarField& pb,
const areaVectorField& tau
);
// Destructor
virtual ~entrainmentModel()
{}
//- Destructor
virtual ~entrainmentModel() = default;
// Member Functions
//- Return the Source by entrainment
virtual const areaScalarField &Sm() const = 0;
virtual const areaScalarField& Sm() const = 0;
//- Return the entrainment properties dictionary
const dictionary& entrainmentProperties() const
......
......@@ -82,24 +82,24 @@ public:
(
const word& name,
const dictionary& frictionProperties,
const areaVectorField &Us,
const areaScalarField &h,
const areaScalarField &p
const areaVectorField& Us,
const areaScalarField& h,
const areaScalarField& p
);
// Destructor
virtual ~DarcyWeisbach()
{}
//- Destructor
virtual ~DarcyWeisbach() = default;
// Member Functions
//- Return explicit coefficients for the linear system of equatiosn considering friction
//- Return explicit coefficients for the linear system of equations
//- considering friction
virtual const areaVectorField& tauSc() const;
//- Return implicit coefficients for the linear system of equatiosn considering friction
//- Return implicit coefficients for the linear system of equations
//- considering friction
virtual const areaScalarField& tauSp() const;
......
......@@ -21,7 +21,6 @@ License
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::frictionModels::ManningStrickler
......@@ -58,7 +57,7 @@ namespace frictionModels
{
/*---------------------------------------------------------------------------*\
Class DaryWeisbach Declaration
Class ManningStrickler Declaration
\*---------------------------------------------------------------------------*/
class ManningStrickler
......@@ -82,24 +81,24 @@ public:
(
const word& name,
const dictionary& frictionProperties,
const areaVectorField &Us,
const areaScalarField &h,
const areaScalarField &p
const areaVectorField& Us,
const areaScalarField& h,
const areaScalarField& p
);
// Destructor
virtual ~ManningStrickler()
{}
//- Destructor
virtual ~ManningStrickler() = default;
// Member Functions
//- Return explicit coefficients for the linear system of equatiosn considering friction
//- Return explicit coefficients for the linear system of equations
//- considering friction
virtual const areaVectorField &tauSc() const;
//- Return implicit coefficients for the linear system of equatiosn considering friction
//- Return implicit coefficients for the linear system of equations
//- considering friction
virtual const areaScalarField &tauSp() const;
......
......@@ -51,7 +51,6 @@ Author
#include "uniformDimensionedFields.H"
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
namespace Foam
......@@ -69,22 +68,22 @@ class PoliquenForterre
{
// Private data
//PoliquenForterre firction parameter L
//PoliquenForterre friction parameter L
dimensionedScalar L_;
//PoliquenForterre firction parameter beta
//PoliquenForterre friction parameter beta
dimensionedScalar beta_;
//PoliquenForterre firction parameter zeta1
//PoliquenForterre friction parameter zeta1
dimensionedScalar zeta1_;
//PoliquenForterre firction parameter zeta2
//PoliquenForterre friction parameter zeta2
dimensionedScalar zeta2_;
//PoliquenForterre firction parameter zeta3
//PoliquenForterre friction parameter zeta3
dimensionedScalar zeta3_;
//PoliquenForterre firction parameter zeta3
//PoliquenForterre friction parameter zeta3
dimensionedScalar gamma_;
//mu effective
......@@ -106,24 +105,24 @@ public:
(
const word& name,
const dictionary& frictionProperties,
const areaVectorField &Us,
const areaScalarField &h,
const areaScalarField &p
const areaVectorField& Us,
const areaScalarField& h,
const areaScalarField& p
);
// Destructor
virtual ~PoliquenForterre()
{}
//- Destructor
virtual ~PoliquenForterre() = default;
// Member Functions
//- Return explicit coefficients for the linear system of equatiosn considering friction
//- Return explicit coefficients for the linear system of equations
//- considering friction
virtual const areaVectorField &tauSc() const;
//- Return implicit coefficients for the linear system of equatiosn considering friction
//- Return implicit coefficients for the linear system of equations
//- considering friction
virtual const areaScalarField &tauSp() const;
......
......@@ -50,7 +50,6 @@ Author
#include "faMatrices.H"
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
namespace Foam
......@@ -68,11 +67,12 @@ class Voellmy
{
// Private data
//Coulomb firction parameter m
//Coulomb friction parameter m
dimensionedScalar mu_;
//Voellmy firction parameter xi
//Voellmy friction parameter xi
dimensionedScalar xi_;
public:
//- Runtime type information
......@@ -86,25 +86,25 @@ public:
(
const word& name,
const dictionary& frictionProperties,
const areaVectorField &Us,
const areaScalarField &h,
const areaScalarField &p
const areaVectorField& Us,
const areaScalarField& h,
const areaScalarField& p
);
// Destructor
virtual ~Voellmy()
{}
//- Destructor
virtual ~Voellmy() = default;
// Member Functions
//- Return explicit coefficients for the linear system of equatiosn considering friction
virtual const areaVectorField &tauSc() const;
//- Return explicit coefficients for the linear system of equations
//- considering friction
virtual const areaVectorField& tauSc() const;
//- Return implicit coefficients for the linear system of equatiosn considering friction
virtual const areaScalarField &tauSp() const;
//- Return implicit coefficients for the linear system of equations
//- considering friction
virtual const areaScalarField& tauSp() const;
//- Return the friction properties dictionary
......
......@@ -72,41 +72,41 @@ protected:
// Protected data
word name_;
dictionary frictionProperties_;
dictionary frictionProperties_;
//The density
//- The density
dimensionedScalar rho_;
//tolerance for velocity
//- Tolerance for velocity
dimensionedScalar u0_;
//tolerance for flow height
//- Tolerance for flow height
dimensionedScalar h0_;
//Pointer to the surface velocity field
const areaVectorField &Us_;
//- Reference to the surface velocity field
const areaVectorField& Us_;
//Pointer to the flow height field
const areaScalarField &h_;
//- Reference to the flow height field
const areaScalarField& h_;
//Pointer to the bottom pressure field
const areaScalarField &p_;
//- Reference to the bottom pressure field
const areaScalarField& p_;
//Implicit part of friction
//- Implicit part of friction
mutable areaScalarField tauSp_;
//Explicit part of friction
//- Explicit part of friction
mutable areaVectorField tauSc_;
// Private Member Functions