ENH: autoLayerDriver: better layering information message
[OpenFOAM-2.0.x.git] / src / OpenFOAM / fields / cloud / cloud.H
blob457858838023482daf5c4d5ad5e2efd34a76ba22
1 /*---------------------------------------------------------------------------*\
2   =========                 |
3   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
4    \\    /   O peration     |
5     \\  /    A nd           | Copyright (C) 2011 OpenFOAM Foundation
6      \\/     M anipulation  |
7 -------------------------------------------------------------------------------
8 License
9     This file is part of OpenFOAM.
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.
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.
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/>.
24 Class
25     Foam::cloud
27 Description
28     A cloud is a collection of lagrangian particles
30 SourceFiles
31     cloud.C
33 \*---------------------------------------------------------------------------*/
35 #ifndef cloud_H
36 #define cloud_H
38 #include "objectRegistry.H"
40 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
42 namespace Foam
45 // Forward declaration of classes
46 class mapPolyMesh;
48 /*---------------------------------------------------------------------------*\
49                             Class cloud Declaration
50 \*---------------------------------------------------------------------------*/
52 class cloud
54     public objectRegistry
57     // Private Member Functions
59         //- Disallow default bitwise copy construct
60         cloud(const cloud&);
62         //- Disallow default bitwise assignment
63         void operator=(const cloud&);
66 public:
68     //- Runtime type information
69     TypeName("cloud");
71         //- The prefix to local: %lagrangian
72         static const word prefix;
74         //- The default cloud name: %defaultCloud
75         static word defaultName;
78     // Constructors
80         //- Construct for the given objectRegistry and named cloud instance
81         cloud(const objectRegistry&, const word& cloudName = "");
84     //- Destructor
85     virtual ~cloud();
88     // Member Functions
90         // Edit
92             //- Remap the cells of particles corresponding to the
93             //  mesh topology change
94             virtual void autoMap(const mapPolyMesh&);
98 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
100 } // End namespace Foam
102 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
104 #endif
106 // ************************************************************************* //