mirror of
https://github.com/OpenFOAM/OpenFOAM-6.git
synced 2025-12-08 06:57:46 +00:00
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.
155 lines
4.1 KiB
C++
155 lines
4.1 KiB
C++
/*---------------------------------------------------------------------------*\
|
|
========= |
|
|
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
|
|
\\ / O peration |
|
|
\\ / A nd | Copyright (C) 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::writeVTK
|
|
|
|
Group
|
|
grpUtilitiesFunctionObjects
|
|
|
|
Description
|
|
This functionObject writes objects registered to the database in VTK format
|
|
using the foamToVTK library.
|
|
|
|
Currently only the writing of the cell-values of volFields is supported but
|
|
support for other field types, patch fields, Lagrangian data etc. will be
|
|
added.
|
|
|
|
Example of function object specification:
|
|
\verbatim
|
|
writeVTK1
|
|
{
|
|
type writeVTK;
|
|
libs ("libIOFunctionObjects.so");
|
|
...
|
|
objectNames (obj1 obj2);
|
|
}
|
|
\endverbatim
|
|
|
|
\heading Function object usage
|
|
\table
|
|
Property | Description | Required | Default value
|
|
type | type name: writeVTK | yes |
|
|
objectNames | objects to write | yes |
|
|
\endtable
|
|
|
|
SeeAlso
|
|
Foam::functionObjects::fvMeshFunctionObject
|
|
Foam::functionObjects::timeControl
|
|
|
|
SourceFiles
|
|
writeVTK.C
|
|
IOwriteVTK.H
|
|
|
|
\*---------------------------------------------------------------------------*/
|
|
|
|
#ifndef functionObjects_writeVTK_H
|
|
#define functionObjects_writeVTK_H
|
|
|
|
#include "fvMeshFunctionObject.H"
|
|
#include "wordReList.H"
|
|
|
|
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
|
|
|
|
namespace Foam
|
|
{
|
|
namespace functionObjects
|
|
{
|
|
|
|
/*---------------------------------------------------------------------------*\
|
|
Class writeVTK Declaration
|
|
\*---------------------------------------------------------------------------*/
|
|
|
|
class writeVTK
|
|
:
|
|
public fvMeshFunctionObject
|
|
{
|
|
// Private data
|
|
|
|
//- Names of objects
|
|
wordReList objectNames_;
|
|
|
|
|
|
// Private Member Functions
|
|
|
|
template<class GeoField>
|
|
UPtrList<const GeoField> lookupFields() const;
|
|
|
|
//- Disallow default bitwise copy construct
|
|
writeVTK(const writeVTK&);
|
|
|
|
//- Disallow default bitwise assignment
|
|
void operator=(const writeVTK&);
|
|
|
|
|
|
public:
|
|
|
|
//- Runtime type information
|
|
TypeName("writeVTK");
|
|
|
|
|
|
// Constructors
|
|
|
|
//- Construct from Time and dictionary
|
|
writeVTK
|
|
(
|
|
const word& name,
|
|
const Time& t,
|
|
const dictionary&
|
|
);
|
|
|
|
|
|
//- Destructor
|
|
virtual ~writeVTK();
|
|
|
|
|
|
// Member Functions
|
|
|
|
//- Read the writeVTK data
|
|
virtual bool read(const dictionary&);
|
|
|
|
//- Execute, currently does nothing
|
|
virtual bool execute(const bool postProcess = false);
|
|
|
|
//- Write the writeVTK
|
|
virtual bool write(const bool postProcess = false);
|
|
};
|
|
|
|
|
|
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
|
|
|
|
} // End namespace functionObjects
|
|
} // End namespace Foam
|
|
|
|
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
|
|
|
|
#ifdef NoRepository
|
|
#include "writeVTKTemplates.C"
|
|
#endif
|
|
|
|
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
|
|
|
|
#endif
|
|
|
|
// ************************************************************************* //
|