cloud.H 3.87 KB
Newer Older
1 2 3 4
/*---------------------------------------------------------------------------*\
  =========                 |
  \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
   \\    /   O peration     |
5
    \\  /    A nd           | Copyright (C) 2011-2016 OpenFOAM Foundation
6
     \\/     M anipulation  | Copyright (C) 2016-2018 OpenCFD Ltd.
7 8 9 10
-------------------------------------------------------------------------------
License
    This file is part of OpenFOAM.

11 12 13 14
    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.
15 16 17 18 19 20 21

    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
22
    along with OpenFOAM.  If not, see <http://www.gnu.org/licenses/>.
23 24 25 26 27

Class
    Foam::cloud

Description
28
    A cloud is a registry collection of lagrangian particles.
29 30 31 32 33 34 35 36 37 38

SourceFiles
    cloud.C

\*---------------------------------------------------------------------------*/

#ifndef cloud_H
#define cloud_H

#include "objectRegistry.H"
39
#include "Enum.H"
40
#include "IOField.H"
41 42 43 44 45 46 47 48 49 50

// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //

namespace Foam
{

// Forward declaration of classes
class mapPolyMesh;

/*---------------------------------------------------------------------------*\
Mark Olesen's avatar
Mark Olesen committed
51
                            Class cloud Declaration
52 53 54 55 56 57 58 59 60 61
\*---------------------------------------------------------------------------*/

class cloud
:
    public objectRegistry
{

    // Private Member Functions

        //- Disallow default bitwise copy construct
62
        cloud(const cloud&) = delete;
63 64

        //- Disallow default bitwise assignment
65
        void operator=(const cloud&) = delete;
66 67 68 69


public:

70 71 72 73 74 75 76 77 78 79
    //- Cloud geometry type (internal or IO representations)
    enum class geometryType
    {
        COORDINATES,    //!< barycentric coordinates
        POSITIONS       //!< positions
    };

    static const Enum<geometryType> geometryTypeNames;


80 81 82
    //- Runtime type information
    TypeName("cloud");

83 84
        //- The prefix to local: %lagrangian
        static const word prefix;
Mark Olesen's avatar
Mark Olesen committed
85 86 87

        //- The default cloud name: %defaultCloud
        static word defaultName;
88

Andrew Heather's avatar
Andrew Heather committed
89

90 91 92
    // Constructors

        //- Construct for the given objectRegistry and named cloud instance
93
        cloud(const objectRegistry&, const word& cloudName = defaultName);
94 95


Andrew Heather's avatar
Andrew Heather committed
96
    //- Destructor
97
    virtual ~cloud() = default;
98 99 100 101 102 103 104 105


    // Member Functions

        // Edit

            //- Remap the cells of particles corresponding to the
            //  mesh topology change
106
            virtual void autoMap(const mapPolyMesh&);
107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124


        // I-O

            //- Read particle fields from objects in the obr registry
            //virtual void readObjects(objectRegistry& obr);

            //- Write particle fields as objects into the obr registry
            virtual void writeObjects(objectRegistry& obr) const;

            //- Helper to construct IOField on a supplied object registry
            template<class Type>
            static IOField<Type>& createIOField
            (
                const word& fieldName,
                const label nParticle,
                objectRegistry& obr
            );
125 126 127 128 129 130 131 132 133
};


// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //

} // End namespace Foam

// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //

134 135 136 137 138 139
#ifdef NoRepository
    #include "cloudTemplates.C"
#endif

// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //

140 141 142
#endif

// ************************************************************************* //