Newer
Older
/*---------------------------------------------------------------------------*\
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration |
\\ / A nd | Copyright (C) 2016-2018 OpenCFD Ltd.
\\/ M anipulation |
-------------------------------------------------------------------------------
| Copyright (C) 2011-2016 OpenFOAM Foundation
-------------------------------------------------------------------------------
License
This file is part of OpenFOAM.
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.
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
along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
Class
Foam::cloud
Description
A cloud is a registry collection of lagrangian particles.
SourceFiles
cloud.C
\*---------------------------------------------------------------------------*/
#ifndef cloud_H
#define cloud_H
#include "objectRegistry.H"
#include "Enum.H"
Andrew Heather
committed
#include "IOField.H"
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
namespace Foam
{
// Forward declaration of classes
class mapPolyMesh;
/*---------------------------------------------------------------------------*\
\*---------------------------------------------------------------------------*/
class cloud
:
public objectRegistry
{
// Private Member Functions
//- No copy construct
cloud(const cloud&) = delete;
//- No copy assignment
void operator=(const cloud&) = delete;
//- Cloud geometry type (internal or IO representations)
enum class geometryType
{
COORDINATES, //!< barycentric coordinates
POSITIONS //!< positions
};
static const Enum<geometryType> geometryTypeNames;
//- Runtime type information
TypeName("cloud");
//- The prefix to local: %lagrangian
static const word prefix;
//- The default cloud name: %defaultCloud
static word defaultName;
// Constructors
//- Construct for the given objectRegistry and named cloud instance
cloud(const objectRegistry&, const word& cloudName = defaultName);
virtual ~cloud() = default;
// Member Functions
// Edit
//- Remap the cells of particles corresponding to the
// mesh topology change
virtual void autoMap(const mapPolyMesh&);
Andrew Heather
committed
// 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
);
};
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
} // End namespace Foam
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
Andrew Heather
committed
#ifdef NoRepository
#include "cloudTemplates.C"
#endif
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
#endif
// ************************************************************************* //