cloud_functionObject.C
Go to the documentation of this file.
1 /*---------------------------------------------------------------------------*\
2  ========= |
3  \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
4  \\ / O peration | Website: https://openfoam.org
5  \\ / A nd | Copyright (C) 2025 OpenFOAM Foundation
6  \\/ M anipulation |
7 -------------------------------------------------------------------------------
8 License
9  This file is part of OpenFOAM.
10 
11  OpenFOAM is free software: you can redistribute it and/or modify it
12  under the terms of the GNU General Public License as published by
13  the Free Software Foundation, either version 3 of the License, or
14  (at your option) any later version.
15 
16  OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
17  ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
18  FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
19  for more details.
20 
21  You should have received a copy of the GNU General Public License
22  along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
23 
24 \*---------------------------------------------------------------------------*/
25 
26 #include "cloud_functionObject.H"
27 
28 // * * * * * * * * * * * * * * Static Data Members * * * * * * * * * * * * * //
29 
30 namespace Foam
31 {
32 namespace functionObjects
33 {
35 }
36 }
37 
38 
39 // * * * * * * * * * * * * * * * * Destructor * * * * * * * * * * * * * * * //
40 
42 {}
43 
44 
45 // * * * * * * * * * * * * * * Member Functions * * * * * * * * * * * * * * //
46 
48 {
49  return wordList::null();
50 }
51 
52 
54 {
55  return false;
56 }
57 
58 
60 {
61  cloudPtr_->solve();
62  Info<< endl;
63  return true;
64 }
65 
66 
68 {
69  cloudPtr_->mesh().write();
70  return true;
71 }
72 
73 
75 {}
76 
77 
79 {
80  cloudPtr_->topoChange(map);
81 }
82 
83 
85 {
86  cloudPtr_->mapMesh(map);
87 }
88 
89 
91 {
92  cloudPtr_->distribute(map);
93 }
94 
95 
96 // ************************************************************************* //
static const List< word > & null()
Return a null List.
Definition: ListI.H:118
Function object that solves for the evolution of a cloud. Only provides one-way coupling with a finit...
virtual wordList fields() const
Return the list of fields required.
virtual bool executeAtStart() const
Return false so that this function does not execute at the start.
virtual void topoChange(const polyTopoChangeMap &)
Update topology using the given map.
virtual void distribute(const polyDistributionMap &)
Redistribute or update using the given distribution map.
virtual void mapMesh(const polyMeshMap &)
Update from another mesh using the given map.
virtual void movePoints(const polyMesh &)
Update for mesh motion.
virtual bool execute()
Solve the cloud.
virtual bool write()
Dummy write.
Class containing mesh-to-mesh mapping information after a mesh distribution where we send parts of me...
Class containing mesh-to-mesh mapping information.
Definition: polyMeshMap.H:51
Mesh consisting of general polyhedral cells.
Definition: polyMesh.H:80
Class containing mesh-to-mesh mapping information after a change in polyMesh topology.
defineTypeNameAndDebug(adjustTimeStepToCombustion, 0)
Namespace for OpenFOAM.
Ostream & endl(Ostream &os)
Add newline and flush stream.
Definition: Ostream.H:258
messageStream Info