FreeFOAM The Cross-Platform CFD Toolkit
uncoupledKinematicParcelFoam.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 | Copyright (C) 2008-2010 OpenCFD Ltd.
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 Application
25  uncoupledKinematicParcelFoam
26 
27 Description
28  Transient solver for the passive transport of a single kinematic
29  particle cloud.
30 
31  Uses a pre- calculated velocity field to evolve the cloud.
32 
33 Usage
34  - uncoupledKinematicParcelFoam [OPTION]
35 
36  @param -cloudName <cloud name> \n
37  Use an alternative cloude name to kinematicCloud.
38 
39  @param -case <dir> \n
40  Specify the case directory
41 
42  @param -parallel \n
43  Run the case in parallel
44 
45  @param -help \n
46  Display short usage message
47 
48  @param -doc \n
49  Display Doxygen documentation page
50 
51  @param -srcDoc \n
52  Display source code
53 
54 \*---------------------------------------------------------------------------*/
55 
56 #include <finiteVolume/fvCFD.H>
60 
61 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
62 
63 int main(int argc, char *argv[])
64 {
65  argList::validOptions.insert("cloudName", "cloud name");
66 
67  #include <OpenFOAM/setRootCase.H>
68  #include <OpenFOAM/createTime.H>
69  #include <OpenFOAM/createMesh.H>
71  #include "createFields.H"
73 
74  // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
75 
76  Info<< "\nStarting time loop\n" << endl;
77 
78  while (runTime.loop())
79  {
80  Info<< "Time = " << runTime.timeName() << nl << endl;
81 
82  Info<< "Evolving " << kinematicCloud.name() << endl;
83  kinematicCloud.evolve();
84  kinematicCloud.info();
85 
86  runTime.write();
87 
88  Info<< "ExecutionTime = " << runTime.elapsedCpuTime() << " s"
89  << " ClockTime = " << runTime.elapsedClockTime() << " s"
90  << nl << endl;
91  }
92 
93  Info<< "End\n" << endl;
94 
95  return 0;
96 }
97 
98 
99 // ************************ vim: set sw=4 sts=4 et: ************************ //