Newer
Older
/*---------------------------------------------------------------------------*\
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration |
-------------------------------------------------------------------------------

Andrew Heather
committed
Copyright (C) 2020 OpenCFD Ltd.
-------------------------------------------------------------------------------
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/>.
Foam::CloudFunctionObject
Group
grpLagrangianIntermediateFunctionObjects
Templated cloud function object base class
CloudFunctionObject.C
CloudFunctionObjectNew.C
\*---------------------------------------------------------------------------*/
#ifndef CloudFunctionObject_H
#define CloudFunctionObject_H
#include "IOdictionary.H"
#include "autoPtr.H"
#include "runTimeSelectionTables.H"
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
namespace Foam
{
/*---------------------------------------------------------------------------*\
Class CloudFunctionObject Declaration
\*---------------------------------------------------------------------------*/
template<class CloudType>
class CloudFunctionObject

Andrew Heather
committed
private:
//- Convenience typedef for parcel type
typedef typename CloudType::parcelType parcelType;
// Private data
//- Output path
fileName outputDir_;
// Private Member Functions
using CloudSubModelBase<CloudType>::write;
//- Write post-processing info
virtual void write();
public:
//- Runtime type information
TypeName("cloudFunctionObject");
//- Declare runtime constructor selection table
declareRunTimeSelectionTable
(
autoPtr,
CloudFunctionObject,
dictionary,
(
const dictionary& dict,
);
// Constructors
//- Construct null from owner
CloudFunctionObject(CloudType& owner);
//- Construct from dictionary
CloudFunctionObject
(
const dictionary& dict,
CloudType& owner,
const word& objectType,
const word& modelName
//- Construct copy
CloudFunctionObject(const CloudFunctionObject<CloudType>& ppm);
//- Construct and return a clone
Henry Weller
committed
virtual autoPtr<CloudFunctionObject<CloudType>> clone() const
Henry Weller
committed
return autoPtr<CloudFunctionObject<CloudType>>
new CloudFunctionObject<CloudType>(*this)

Andrew Heather
committed
virtual ~CloudFunctionObject() = default;
Henry Weller
committed
static autoPtr<CloudFunctionObject<CloudType>> New
(
const dictionary& dict,
CloudType& owner,
const word& objectType,
const word& modelName
);
// Member Functions
// Evaluation

Andrew Heather
committed
virtual void preEvolve(const typename parcelType::trackingData& td);
//- Post-evolve hook

Andrew Heather
committed
virtual void postEvolve
(
const typename parcelType::trackingData& td
);
virtual bool postMove

Andrew Heather
committed
parcelType& p,
const typename parcelType::trackingData& td
//- Post-patch hook
virtual bool postPatch

Andrew Heather
committed
const parcelType& p,
const polyPatch& pp,
const typename parcelType::trackingData& td
//- Post-face hook
virtual bool postFace

Andrew Heather
committed
const parcelType& p,
const typename parcelType::trackingData& td
// Input/output
//- Return the output path
const fileName& outputDir() const;
//- Return the output time path
Henry Weller
committed
fileName writeTimeDir() const;
};
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
} // End namespace Foam
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
#define makeCloudFunctionObject(CloudType) \
\
typedef Foam::CloudType::kinematicCloudType kinematicCloudType; \
defineNamedTemplateTypeNameAndDebug \
( \
Foam::CloudFunctionObject<kinematicCloudType>, \
0 \
); \
namespace Foam \
{ \
defineTemplateRunTimeSelectionTable \
( \
CloudFunctionObject<kinematicCloudType>, \
dictionary \
); \
}
#define makeCloudFunctionObjectType(SS, CloudType) \
\
typedef Foam::CloudType::kinematicCloudType kinematicCloudType; \
defineNamedTemplateTypeNameAndDebug(Foam::SS<kinematicCloudType>, 0); \
\
Foam::CloudFunctionObject<kinematicCloudType>:: \
adddictionaryConstructorToTable<Foam::SS<kinematicCloudType>> \
add##SS##CloudType##kinematicCloudType##ConstructorToTable_;
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
#ifdef NoRepository
#include "CloudFunctionObject.C"
#endif
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
#endif
// ************************************************************************* //