File size: 7,624 Bytes
5a600cf | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 | /*---------------------------------------------------------------------------*\
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration | Website: https://openfoam.org
\\ / A nd | Copyright (C) 2011-2024 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::CloudFunctionObject
Description
Templated cloud function object base class
SourceFiles
CloudFunctionObject.C
CloudFunctionObjectNew.C
\*---------------------------------------------------------------------------*/
#ifndef CloudFunctionObject_H
#define CloudFunctionObject_H
#include "IOdictionary.H"
#include "autoPtr.H"
#include "runTimeSelectionTables.H"
#include "CloudSubModelBase.H"
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
namespace Foam
{
class polyPatch;
class tetIndices;
/*---------------------------------------------------------------------------*\
Class CloudFunctionObject Declaration
\*---------------------------------------------------------------------------*/
template<class CloudType>
class CloudFunctionObject
:
public CloudSubModelBase<CloudType>
{
// Private Data
//- Output path
fileName outputDir_;
// Private Member Functions
//- Inherit write from CloudSubModelBase
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,
CloudType& owner,
const word& modelName
),
(dict, owner, modelName)
);
// 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
virtual autoPtr<CloudFunctionObject<CloudType>> clone() const
{
return autoPtr<CloudFunctionObject<CloudType>>
(
new CloudFunctionObject<CloudType>(*this)
);
}
//- Destructor
virtual ~CloudFunctionObject();
//- Selector
static autoPtr<CloudFunctionObject<CloudType>> New
(
const dictionary& dict,
CloudType& owner,
const word& objectType,
const word& modelName
);
// Member Functions
// Evaluation
//- Pre-evolve hook
virtual void preEvolve();
//- Post-evolve hook
virtual void postEvolve();
//- Post-move hook
virtual void postMove
(
typename CloudType::parcelType& p,
const scalar dt,
const point& position0,
bool& keepParticle
);
//- Post-patch hook
virtual void postPatch
(
const typename CloudType::parcelType& p,
const polyPatch& pp
);
//- Pre-face hook
virtual void preFace(const typename CloudType::parcelType& p);
//- Post-face hook
virtual void postFace(const typename CloudType::parcelType& p);
// Input/output
//- Return the output path
const fileName& outputDir() const;
//- Return the output time path
fileName writeTimeDir() const;
};
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
} // End namespace Foam
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
#define makeCloudFunctionObject(CloudType) \
\
typedef Foam::CloudType::momentumCloudType CloudType##momentumCloudType; \
\
defineNamedTemplateTypeNameAndDebug \
( \
Foam::CloudFunctionObject<CloudType##momentumCloudType>, \
0 \
); \
\
namespace Foam \
{ \
defineTemplateRunTimeSelectionTable \
( \
CloudFunctionObject<CloudType##momentumCloudType>, \
dictionary \
); \
}
#define makeCloudFunctionObjectType(SS, CloudType) \
\
typedef Foam::CloudType::momentumCloudType CloudType##momentumCloudType; \
\
defineNamedTemplateTypeNameAndDebug \
( \
Foam::SS<CloudType##momentumCloudType>, \
0 \
); \
\
Foam::CloudFunctionObject<CloudType##momentumCloudType>:: \
adddictionaryConstructorToTable<Foam::SS<CloudType##momentumCloudType>>\
add##SS##CloudType##momentumCloudType##ConstructorToTable_;
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
#ifdef NoRepository
#include "CloudFunctionObject.C"
#endif
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
#endif
// ************************************************************************* //
|