File size: 5,879 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 | /*---------------------------------------------------------------------------*\
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration | Website: https://openfoam.org
\\ / A nd | Copyright (C) 2025 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::functionObjects::cloud
Description
Function object that solves for the evolution of a cloud. Only provides
one-way coupling with a finite-volume carrier phase. The carrier phase
affects the cloud, but the cloud does not affect the carrier phase.
SourceFiles
cloud_functionObject.C
cloud_functionObjectTemplates.C
\*---------------------------------------------------------------------------*/
#ifndef cloud_functionObject_H
#define cloud_functionObject_H
#include "regionFunctionObject.H"
#include "cloud.H"
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
namespace Foam
{
namespace functionObjects
{
/*---------------------------------------------------------------------------*\
Class cloud Declaration
\*---------------------------------------------------------------------------*/
class cloud
:
public regionFunctionObject
{
// Private Data
//- The cloud
autoPtr<Foam::cloud> cloudPtr_;
protected:
// Protected Classes
//- Empty template class used to template the constructor on the type
// of the cloud
template<class Type>
class Cloud
{};
// Protected Constructors
//- Construct from components
template<class Type>
cloud
(
const word& name,
const Time& runTime,
const dictionary& dict,
const Cloud<Type>&
);
public:
// Public Static Data
//- Run-time type information
TypeName("cloud");
//- Destructor
virtual ~cloud();
// Member Functions
//- Return the list of fields required
virtual wordList fields() const;
//- Return false so that this function does not execute at the start
virtual bool executeAtStart() const;
//- Solve the cloud
virtual bool execute();
//- Dummy write
virtual bool write();
// Mesh changes
//- Update for mesh motion
virtual void movePoints(const polyMesh&);
//- Update topology using the given map
virtual void topoChange(const polyTopoChangeMap&);
//- Update from another mesh using the given map
virtual void mapMesh(const polyMeshMap&);
//- Redistribute or update using the given distribution map
virtual void distribute(const polyDistributionMap&);
};
/*---------------------------------------------------------------------------*\
Class Cloud Declaration
\*---------------------------------------------------------------------------*/
template<class Type>
class Cloud
:
public cloud
{
public:
// Public Static Data
//- Run-time type information
TypeName("Cloud");
// Constructors
//- Construct from components
Cloud
(
const word& name,
const Time& runTime,
const dictionary& dict
);
};
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
} // End namespace functionObjects
} // End namespace Foam
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
#ifdef NoRepository
#include "cloud_functionObjectTemplates.C"
#endif
#define makeCloudFunctionObject(Type) \
\
typedef Cloud<clouds::Type> Type##CloudFunctionObject; \
\
defineTemplateTypeNameAndDebugWithName \
( \
Type##CloudFunctionObject, \
(clouds::Type::typeName + "Cloud").c_str(), \
0 \
); \
\
addToRunTimeSelectionTable \
( \
functionObject, \
Type##CloudFunctionObject, \
dictionary \
);
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
#endif
// ************************************************************************* //
|