Files
OpenFOAM-6/src/lagrangian/solidParticle/solidParticle.H
Will Bainbridge dc10cfd686 lagrangian: Removed duplicate data from method arguments
A lot of methods were taking argument data which could be referenced or
generated from the parcel class at little or no additional cost. This
was confusing and generated the possibility of inconsistent data states.
2017-09-04 12:01:28 +01:00

269 lines
7.0 KiB
C++

/*---------------------------------------------------------------------------*\
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration |
\\ / A nd | Copyright (C) 2011-2017 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::solidParticle
Description
Simple solid spherical particle class with one-way coupling with the
continuous phase.
SourceFiles
solidParticleI.H
solidParticle.C
solidParticleIO.C
\*---------------------------------------------------------------------------*/
#ifndef solidParticle_H
#define solidParticle_H
#include "particle.H"
#include "IOstream.H"
#include "autoPtr.H"
#include "interpolationCellPoint.H"
#include "contiguous.H"
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
namespace Foam
{
class solidParticleCloud;
// Forward declaration of friend functions and operators
class solidParticle;
Ostream& operator<<(Ostream&, const solidParticle&);
/*---------------------------------------------------------------------------*\
Class solidParticle Declaration
\*---------------------------------------------------------------------------*/
class solidParticle
:
public particle
{
// Private data
//- Size in bytes of the fields
static const std::size_t sizeofFields_;
//- Diameter
scalar d_;
//- Velocity of parcel
vector U_;
public:
friend class Cloud<solidParticle>;
//- Class used to pass tracking data to the trackToFace function
class trackingData
:
public particle::trackingData
{
// Interpolators for continuous phase fields
const interpolationCellPoint<scalar>& rhoInterp_;
const interpolationCellPoint<vector>& UInterp_;
const interpolationCellPoint<scalar>& nuInterp_;
//- Local gravitational or other body-force acceleration
const vector& g_;
public:
// Constructors
inline trackingData
(
const solidParticleCloud& spc,
const interpolationCellPoint<scalar>& rhoInterp,
const interpolationCellPoint<vector>& UInterp,
const interpolationCellPoint<scalar>& nuInterp,
const vector& g
);
// Member functions
inline const interpolationCellPoint<scalar>& rhoInterp() const;
inline const interpolationCellPoint<vector>& UInterp() const;
inline const interpolationCellPoint<scalar>& nuInterp() const;
inline const vector& g() const;
};
// Constructors
//- Construct from components
inline solidParticle
(
const polyMesh& mesh,
const barycentric& coordinates,
const label celli,
const label tetFacei,
const label tetPti,
const scalar d,
const vector& U
);
//- Construct from Istream
solidParticle
(
const polyMesh& mesh,
Istream& is,
bool readFields = true
);
//- Construct and return a clone
virtual autoPtr<particle> clone() const
{
return autoPtr<particle>(new solidParticle(*this));
}
//- Factory class to read-construct particles used for
// parallel transfer
class iNew
{
const polyMesh& mesh_;
public:
iNew(const polyMesh& mesh)
:
mesh_(mesh)
{}
autoPtr<solidParticle> operator()(Istream& is) const
{
return autoPtr<solidParticle>
(
new solidParticle(mesh_, is, true)
);
}
};
// Member Functions
// Access
//- Return diameter
inline scalar d() const;
//- Return velocity
inline const vector& U() const;
// Tracking
//- Move
bool move(solidParticleCloud&, trackingData&, const scalar);
// Patch interactions
//- Overridable function to handle the particle hitting a patch
// Executed before other patch-hitting functions
bool hitPatch
(
const polyPatch&,
solidParticleCloud& cloud,
trackingData& td
);
//- Overridable function to handle the particle hitting a
// processorPatch
void hitProcessorPatch
(
const processorPolyPatch&,
solidParticleCloud& cloud,
trackingData& td
);
//- Overridable function to handle the particle hitting a wallPatch
void hitWallPatch
(
const wallPolyPatch&,
solidParticleCloud& cloud,
trackingData& td
);
//- Transform the physical properties of the particle
// according to the given transformation tensor
virtual void transformProperties(const tensor& T);
//- Transform the physical properties of the particle
// according to the given separation vector
virtual void transformProperties(const vector& separation);
//- The nearest distance to a wall that
// the particle can be in the n direction
virtual scalar wallImpactDistance(const vector& n) const;
// I-O
static void readFields(Cloud<solidParticle>& c);
static void writeFields(const Cloud<solidParticle>& c);
// Ostream Operator
friend Ostream& operator<<(Ostream&, const solidParticle&);
};
template<>
inline bool contiguous<solidParticle>()
{
return true;
}
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
} // End namespace Foam
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
#include "solidParticleI.H"
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
#endif
// ************************************************************************* //