mirror of
https://develop.openfoam.com/Development/openfoam.git
synced 2025-11-28 03:28:01 +00:00
161 lines
4.0 KiB
C++
161 lines
4.0 KiB
C++
/*---------------------------------------------------------------------------*\
|
|
========= |
|
|
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
|
|
\\ / O peration |
|
|
\\ / A nd | Copyright (C) 2012 OpenFOAM Foundation
|
|
\\/ M anipulation |
|
|
-------------------------------------------------------------------------------
|
|
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/>.
|
|
|
|
\addtogroup grpCloudFunctionObjects
|
|
@{
|
|
|
|
Class
|
|
Foam::cloudInfo
|
|
|
|
Description
|
|
This function object outputs lagrangian cloud information to a file. The
|
|
current outputs include:
|
|
- total current number of parcels
|
|
- total current mass of parcels
|
|
|
|
SourceFiles
|
|
cloudInfo.C
|
|
IOcloudInfo.H
|
|
@}
|
|
|
|
\*---------------------------------------------------------------------------*/
|
|
|
|
#ifndef cloudInfo_H
|
|
#define cloudInfo_H
|
|
|
|
#include "OFstream.H"
|
|
#include "PtrList.H"
|
|
#include "pointFieldFwd.H"
|
|
#include "volFields.H"
|
|
#include "surfaceFields.H"
|
|
|
|
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
|
|
|
|
namespace Foam
|
|
{
|
|
|
|
// Forward declaration of classes
|
|
class objectRegistry;
|
|
class dictionary;
|
|
class mapPolyMesh;
|
|
|
|
/*---------------------------------------------------------------------------*\
|
|
Class cloudInfo Declaration
|
|
\*---------------------------------------------------------------------------*/
|
|
|
|
class cloudInfo
|
|
{
|
|
protected:
|
|
|
|
// Protected data
|
|
|
|
//- Name of this set of cloudInfo object
|
|
word name_;
|
|
|
|
const objectRegistry& obr_;
|
|
|
|
//- on/off switch
|
|
bool active_;
|
|
|
|
//- Clouds to process
|
|
wordHashSet cloudSet_;
|
|
|
|
//- Output file pointers
|
|
PtrList<OFstream> outputFilePtr_;
|
|
|
|
|
|
// Protected Member Functions
|
|
|
|
//- If the output file has not been created create it
|
|
void makeFiles();
|
|
|
|
//- Disallow default bitwise copy construct
|
|
cloudInfo(const cloudInfo&);
|
|
|
|
//- Disallow default bitwise assignment
|
|
void operator=(const cloudInfo&);
|
|
|
|
|
|
public:
|
|
|
|
//- Runtime type information
|
|
TypeName("cloudInfo");
|
|
|
|
|
|
// Constructors
|
|
|
|
//- Construct for given objectRegistry and dictionary.
|
|
// Allow the possibility to load fields from files
|
|
cloudInfo
|
|
(
|
|
const word& name,
|
|
const objectRegistry&,
|
|
const dictionary&,
|
|
const bool loadFromFiles = false
|
|
);
|
|
|
|
|
|
//- Destructor
|
|
virtual ~cloudInfo();
|
|
|
|
|
|
// Member Functions
|
|
|
|
//- Return name of the cloudInfo object
|
|
virtual const word& name() const
|
|
{
|
|
return name_;
|
|
}
|
|
|
|
//- Read the field min/max data
|
|
virtual void read(const dictionary&);
|
|
|
|
//- Execute, currently does nothing
|
|
virtual void execute();
|
|
|
|
//- Execute at the final time-loop, currently does nothing
|
|
virtual void end();
|
|
|
|
//- Write
|
|
virtual void write();
|
|
|
|
//- Update for changes of mesh
|
|
virtual void updateMesh(const mapPolyMesh&)
|
|
{}
|
|
|
|
//- Update for changes of mesh
|
|
virtual void movePoints(const pointField&)
|
|
{}
|
|
};
|
|
|
|
|
|
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
|
|
|
|
} // End namespace Foam
|
|
|
|
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
|
|
|
|
#endif
|
|
|
|
// ************************************************************************* //
|