File size: 5,124 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-2026 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::cloudBoundaryCollisionFlux
Description
Base class for functions which generate a boundary collision flux for a
cloud
SourceFiles
cloudBoundaryCollisionFlux.C
\*---------------------------------------------------------------------------*/
#ifndef cloudBoundaryCollisionFlux_functionObject_H
#define cloudBoundaryCollisionFlux_functionObject_H
#include "LagrangianPatchField.H"
#include "cloudFvMeshFunctionObject.H"
#include "surfaceFields.H"
#include "LagrangianFields.H"
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
namespace Foam
{
namespace functionObjects
{
/*---------------------------------------------------------------------------*\
Class cloudBoundaryCollisionFlux Declaration
\*---------------------------------------------------------------------------*/
class cloudBoundaryCollisionFlux
:
public cloudFvMeshFunctionObject
{
private:
// Private Data
//- Field of proc indices
autoPtr<LagrangianLabelDynamicField> prociPtr_;
//- Field of face indices
autoPtr<LagrangianLabelDynamicField> faceiPtr_;
//- Field of the property for which to compute the flux
autoPtr<LagrangianScalarDynamicField> qPtr_;
//- Name of the flux
const word phiName_;
//- Dimensions of the flux
const dimensionSet phiDims_;
//- Flux boundary field
surfaceScalarField::Boundary phib_;
// Private Member Functions
//- Return the property for which to compute the flux
virtual tmp<LagrangianSubScalarSubField> q
(
const LagrangianSubScalarSubField& fraction,
const label sign
) const = 0;
public:
//- Runtime type information
TypeName("cloudBoundaryCollisionFlux");
// Constructors
//- Construct from Time and dictionary
cloudBoundaryCollisionFlux
(
const word& name,
const Time& runTime,
const dictionary& dict,
const word& phiName,
const dimensionSet& phiDims
);
//- Disallow default bitwise copy construction
cloudBoundaryCollisionFlux(const cloudBoundaryCollisionFlux&) = delete;
//- Destructor
virtual ~cloudBoundaryCollisionFlux();
// Member Functions
//- Return the list of fields required
virtual wordList fields() const;
//- Return false so this function does not execute at the start
virtual bool executeAtStart() const;
//- Do nothing. Everything happens in faces crossing hooks.
virtual bool execute();
//- Hook before solution steps
virtual void preSolve();
//- 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
);
//- Write the number flux
virtual bool write();
//- Clear the number flux
virtual bool clear();
// Member Operators
//- Disallow default bitwise assignment
void operator=(const cloudBoundaryCollisionFlux&) = delete;
};
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
} // End namespace functionObjects
} // End namespace Foam
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
#endif
// ************************************************************************* //
|