18725ed3ac
This changes simplifies the specification of functionObjects in controlDict and is consistent with the 'libs' option in controlDict to load special solver libraries. Support for the old 'functionObjectLibs' name is supported for backward compatibility.
154 lines
3.8 KiB
C++
154 lines
3.8 KiB
C++
/*---------------------------------------------------------------------------*\
|
|
========= |
|
|
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
|
|
\\ / O peration |
|
|
\\ / A nd | Copyright (C) 2012-2016 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/>.
|
|
|
|
Class
|
|
Foam::functionObjects::cloudInfo
|
|
|
|
Group
|
|
grpLagrangianFunctionObjects
|
|
|
|
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
|
|
|
|
Example of function object specification:
|
|
\verbatim
|
|
cloudInfo1
|
|
{
|
|
type cloudInfo;
|
|
libs ("libcloudFunctionObjects.so");
|
|
...
|
|
clouds
|
|
(
|
|
kinematicCloud1
|
|
thermoCloud1
|
|
);
|
|
}
|
|
\endverbatim
|
|
|
|
|
|
\heading Function object usage
|
|
|
|
\table
|
|
Property | Description | Required | Default value
|
|
type | type name: cloudInfo | yes |
|
|
clouds | list of clouds names to process |yes |
|
|
\endtable
|
|
|
|
The output data of each cloud is written to a file named \<cloudName\>.dat
|
|
|
|
SeeAlso
|
|
Foam::functionObject
|
|
Foam::functionObjects::writeFiles
|
|
|
|
SourceFiles
|
|
cloudInfo.C
|
|
|
|
\*---------------------------------------------------------------------------*/
|
|
|
|
#ifndef functionObjects_cloudInfo_H
|
|
#define functionObjects_cloudInfo_H
|
|
|
|
#include "writeFiles.H"
|
|
|
|
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
|
|
|
|
namespace Foam
|
|
{
|
|
namespace functionObjects
|
|
{
|
|
|
|
/*---------------------------------------------------------------------------*\
|
|
Class cloudInfo Declaration
|
|
\*---------------------------------------------------------------------------*/
|
|
|
|
class cloudInfo
|
|
:
|
|
public writeFiles
|
|
{
|
|
protected:
|
|
|
|
// Protected Member Functions
|
|
|
|
//- File header information
|
|
virtual void writeFileHeader(const label i);
|
|
|
|
|
|
private:
|
|
|
|
// Private member functions
|
|
|
|
//- Disallow default bitwise copy construct
|
|
cloudInfo(const cloudInfo&);
|
|
|
|
//- Disallow default bitwise assignment
|
|
void operator=(const cloudInfo&);
|
|
|
|
|
|
public:
|
|
|
|
//- Runtime type information
|
|
TypeName("cloudInfo");
|
|
|
|
|
|
// Constructors
|
|
|
|
//- Construct from Time and dictionary
|
|
cloudInfo
|
|
(
|
|
const word& name,
|
|
const Time& runTime,
|
|
const dictionary&
|
|
);
|
|
|
|
|
|
//- Destructor
|
|
virtual ~cloudInfo();
|
|
|
|
|
|
// Member Functions
|
|
|
|
//- Read the controls
|
|
virtual bool read(const dictionary&);
|
|
|
|
//- Execute, currently does nothing
|
|
virtual bool execute(const bool postProcess = false);
|
|
|
|
//- Write
|
|
virtual bool write(const bool postProcess = false);
|
|
};
|
|
|
|
|
|
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
|
|
|
|
} // End namespace functionObjects
|
|
} // End namespace Foam
|
|
|
|
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
|
|
|
|
#endif
|
|
|
|
// ************************************************************************* //
|