File size: 4,948 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 | /*---------------------------------------------------------------------------*\
========= |
\\ / 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::cloudFunctionObject
Description
Base class for function objects that refer to a cloud. Provides hooks into
the cloud solution process. Not a function object in itself. Must be mixed
in.
SourceFiles
cloudFunctionObject.C
\*---------------------------------------------------------------------------*/
#ifndef cloudFunctionObject_functionObject_H
#define cloudFunctionObject_functionObject_H
#include "LagrangianMeshFunctionObject.H"
#include "fvMeshFunctionObject.H"
#include "LagrangianFieldsFwd.H"
#include "LagrangianSubFieldsFwd.H"
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
namespace Foam
{
class cloud;
namespace functionObjects
{
/*---------------------------------------------------------------------------*\
Class cloudFunctionObject Declaration
\*---------------------------------------------------------------------------*/
class cloudFunctionObject
{
private:
// Private Data
//- Reference to the function object
const functionObject& function_;
//- Reference to the cloud
const Foam::cloud& cloud_;
protected:
// Protected Member Functions
//- Determine whether the cloud is of the given type
template<class Cloud>
bool isCloud() const;
//- Get a reference to the cloud
template<class Cloud = Foam::cloud>
const Cloud& cloud() const;
public:
//- Runtime type information
TypeName("cloudFunctionObject");
// Constructors
//- Construct from a Lagrangian mesh function object
cloudFunctionObject(const LagrangianMeshFunctionObject&);
//- Construct from an fvMesh function object and a dictionary
cloudFunctionObject
(
const fvMeshFunctionObject&,
const dictionary& dict
);
//- Disallow default bitwise copy construction
cloudFunctionObject
(
const cloudFunctionObject&
) = delete;
//- Destructor
virtual ~cloudFunctionObject();
// Member Functions
//- Return the cloud
const Foam::cloud& cloud() const;
//- Hook before solution steps
virtual void preSolve();
//- Solve equations and/or update continually changing properties
virtual void calculate
(
const LagrangianSubScalarField& deltaT,
const bool final
);
//- Hook before all face crossings
virtual void preCrossFaces
(
const LagrangianInternalScalarDynamicField& fraction
);
//- Hook before face crossings of a specific sub-mesh
virtual void preCrossFaces
(
const LagrangianSubScalarSubField& fraction
);
//- Hook following face crossings of a specific sub-mesh
virtual void postCrossFaces
(
const LagrangianSubScalarSubField& fraction
);
//- Hook after all face crossings
virtual void postCrossFaces
(
const LagrangianInternalScalarDynamicField& fraction
);
//- Hook following solution steps
virtual void postSolve();
// Member Operators
//- Disallow default bitwise assignment
void operator=(const cloudFunctionObject&) = delete;
};
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
} // End namespace functionObjects
} // End namespace Foam
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
#ifdef NoRepository
#include "cloudFunctionObjectTemplates.C"
#endif
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
#endif
// ************************************************************************* //
|