FreezeParticles.C
Go to the documentation of this file.
1 /*---------------------------------------------------------------------------*\
2  ========= |
3  \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
4  \\ / O peration |
5  \\ / A nd | www.openfoam.com
6  \\/ M anipulation |
7 -------------------------------------------------------------------------------
8  Copyright (C) 2024 OpenCFD Ltd.
9 -------------------------------------------------------------------------------
10 License
11  This file is part of OpenFOAM.
12 
13  OpenFOAM is free software: you can redistribute it and/or modify it
14  under the terms of the GNU General Public License as published by
15  the Free Software Foundation, either version 3 of the License, or
16  (at your option) any later version.
17 
18  OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
19  ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
20  FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
21  for more details.
22 
23  You should have received a copy of the GNU General Public License
24  along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
25 
26 \*---------------------------------------------------------------------------*/
27 
28 #include "FreezeParticles.H"
29 
30 // * * * * * * * * * * * * * * * * Constructors * * * * * * * * * * * * * * //
31 
32 template<class CloudType>
34 (
35  const dictionary& dict,
36  CloudType& owner,
37  const word& modelName
38 )
39 :
40  CloudFunctionObject<CloudType>(dict, owner, modelName, typeName)
41 {}
42 
43 
44 template<class CloudType>
46 (
48 )
49 :
51 {}
52 
53 
54 // * * * * * * * * * * * * * * * Member Functions * * * * * * * * * * * * * //
55 
56 template<class CloudType>
58 (
59  const typename parcelType::trackingData& td
60 )
61 {
62  auto& c = this->owner();
63 
64  forAllIters(c, particlePtr)
65  {
66  particlePtr->active(false);
67  }
68 }
69 
70 
71 // ************************************************************************* //
dictionary dict
A list of keyword definitions, which are a keyword followed by a number of values (eg...
Definition: dictionary.H:129
wallPoints::trackData td(isBlockedFace, regionToBlockSize)
virtual void preEvolve(const typename parcelType::trackingData &td)
Pre-evolve hook.
A class for handling words, derived from Foam::string.
Definition: word.H:63
#define forAllIters(container, iter)
Iterate across all elements in the container object.
Definition: stdFoam.H:336
const dimensionedScalar c
Speed of light in a vacuum.
Sets particle active flag to false to freeze particles in space.
Templated base class for dsmc cloud.
Definition: DSMCCloud.H:67
FreezeParticles(const dictionary &dict, CloudType &owner, const word &modelName)
Construct from dictionary.
Templated cloud function object base class.