660f3e5492
Improve alignment of its behaviour with std::unique_ptr
- element_type typedef
- release() method - identical to ptr() method
- get() method to get the pointer without checking and without releasing it.
- operator*() for dereferencing
Method name changes
- renamed rawPtr() to get()
- renamed rawRef() to ref(), removed unused const version.
Removed methods/operators
- assignment from a raw pointer was deleted (was rarely used).
Can be convenient, but uncontrolled and potentially unsafe.
Do allow assignment from a literal nullptr though, since this
can never leak (and also corresponds to the unique_ptr API).
Additional methods
- clone() method: forwards to the clone() method of the underlying
data object with argument forwarding.
- reset(autoPtr&&) as an alternative to operator=(autoPtr&&)
STYLE: avoid implicit conversion from autoPtr to object type in many places
- existing implementation has the following:
operator const T&() const { return operator*(); }
which means that the following code works:
autoPtr<mapPolyMesh> map = ...;
updateMesh(*map); // OK: explicit dereferencing
updateMesh(map()); // OK: explicit dereferencing
updateMesh(map); // OK: implicit dereferencing
for clarity it may preferable to avoid the implicit dereferencing
- prefer operator* to operator() when deferenced a return value
so it is clearer that a pointer is involve and not a function call
etc Eg, return *meshPtr_; vs. return meshPtr_();
169 lines
4.2 KiB
C++
169 lines
4.2 KiB
C++
/*---------------------------------------------------------------------------*\
|
|
========= |
|
|
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
|
|
\\ / O peration |
|
|
\\ / A nd | Copyright (C) 2011-2016 OpenFOAM Foundation
|
|
\\/ M anipulation | Copyright (C) 2016-2018 OpenCFD Ltd.
|
|
-------------------------------------------------------------------------------
|
|
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::vtk::lagrangianWriter
|
|
|
|
Description
|
|
Write lagrangian positions and fields (clouds).
|
|
|
|
SourceFiles
|
|
lagrangianWriter.C
|
|
lagrangianWriterTemplates.C
|
|
|
|
\*---------------------------------------------------------------------------*/
|
|
|
|
#ifndef foamVtkLagrangianWriter_H
|
|
#define foamVtkLagrangianWriter_H
|
|
|
|
#include "Cloud.H"
|
|
#include "volFields.H"
|
|
#include "pointFields.H"
|
|
#include "foamVtkOutputOptions.H"
|
|
#include <fstream>
|
|
|
|
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
|
|
|
|
namespace Foam
|
|
{
|
|
class volPointInterpolation;
|
|
|
|
namespace vtk
|
|
{
|
|
|
|
/*---------------------------------------------------------------------------*\
|
|
Class lagrangianWriter Declaration
|
|
\*---------------------------------------------------------------------------*/
|
|
|
|
class lagrangianWriter
|
|
{
|
|
// Private Member Data
|
|
|
|
//- Reference to the OpenFOAM mesh (or subset)
|
|
const fvMesh& mesh_;
|
|
|
|
//- Commonly used query
|
|
const bool legacy_;
|
|
|
|
//- Write lagrangian as cell data (verts) or point data?
|
|
const bool useVerts_;
|
|
|
|
autoPtr<vtk::formatter> format_;
|
|
|
|
const word cloudName_;
|
|
|
|
std::ofstream os_;
|
|
|
|
label nParcels_;
|
|
|
|
|
|
// Private Member Functions
|
|
|
|
//- Begin piece
|
|
void beginPiece();
|
|
|
|
//- Write positions
|
|
void writePoints();
|
|
|
|
//- Write vertex (cells)
|
|
void writeVertsLegacy();
|
|
|
|
//- Write vertex (cells)
|
|
void writeVerts();
|
|
|
|
|
|
//- Disallow default bitwise copy construct
|
|
lagrangianWriter(const lagrangianWriter&) = delete;
|
|
|
|
//- Disallow default bitwise assignment
|
|
void operator=(const lagrangianWriter&) = delete;
|
|
|
|
|
|
public:
|
|
|
|
// Constructors
|
|
|
|
//- Construct from components
|
|
lagrangianWriter
|
|
(
|
|
const fvMesh& mesh,
|
|
const word& cloudName,
|
|
const fileName& baseName,
|
|
const vtk::outputOptions outOpts,
|
|
const bool dummyCloud = false
|
|
);
|
|
|
|
|
|
//- Destructor
|
|
~lagrangianWriter() = default;
|
|
|
|
|
|
// Member Functions
|
|
|
|
inline std::ofstream& os()
|
|
{
|
|
return os_;
|
|
}
|
|
|
|
inline vtk::formatter& format()
|
|
{
|
|
return *format_;
|
|
}
|
|
|
|
inline label nParcels() const
|
|
{
|
|
return nParcels_;
|
|
}
|
|
|
|
//- Begin parcel data (point data).
|
|
// The nFields parameter is only needed for legacy format.
|
|
void beginParcelData(label nFields);
|
|
void endParcelData();
|
|
|
|
//- Write file footer
|
|
void writeFooter();
|
|
|
|
//- Write IOFields
|
|
template<class Type>
|
|
void writeIOField(const wordList& fieldNames);
|
|
};
|
|
|
|
|
|
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
|
|
|
|
} // End namespace vtk
|
|
} // End namespace Foam
|
|
|
|
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
|
|
|
|
#ifdef NoRepository
|
|
#include "foamVtkLagrangianWriterTemplates.C"
|
|
#endif
|
|
|
|
|
|
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
|
|
|
|
#endif
|
|
|
|
// ************************************************************************* //
|