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_();
157 lines
3.7 KiB
C++
157 lines
3.7 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::faceSelection
|
|
|
|
Description
|
|
Face selection method for createBaffles
|
|
|
|
SourceFiles
|
|
faceSelection.C
|
|
|
|
\*---------------------------------------------------------------------------*/
|
|
|
|
#ifndef faceSelection_H
|
|
#define faceSelection_H
|
|
|
|
#include "dictionary.H"
|
|
#include "typeInfo.H"
|
|
#include "runTimeSelectionTables.H"
|
|
#include "autoPtr.H"
|
|
#include "boolList.H"
|
|
#include "labelList.H"
|
|
#include "Switch.H"
|
|
|
|
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
|
|
|
|
namespace Foam
|
|
{
|
|
|
|
// Forward declaration of classes
|
|
class fvMesh;
|
|
|
|
/*---------------------------------------------------------------------------*\
|
|
Class faceSelection Declaration
|
|
\*---------------------------------------------------------------------------*/
|
|
|
|
class faceSelection
|
|
{
|
|
protected:
|
|
|
|
// Protected data
|
|
|
|
//- Name
|
|
const word name_;
|
|
|
|
//- Reference to mesh
|
|
const fvMesh& mesh_;
|
|
|
|
//- Input dictionary
|
|
const dictionary dict_;
|
|
|
|
//- Switch direction?
|
|
const Switch flip_;
|
|
|
|
public:
|
|
|
|
//- Runtime type information
|
|
TypeName("faceSelection");
|
|
|
|
|
|
// Declare run-time constructor selection table
|
|
|
|
declareRunTimeSelectionTable
|
|
(
|
|
autoPtr,
|
|
faceSelection,
|
|
dictionary,
|
|
(
|
|
const word& name,
|
|
const fvMesh& mesh,
|
|
const dictionary& dict
|
|
),
|
|
(name, mesh, dict)
|
|
);
|
|
|
|
|
|
// Constructors
|
|
|
|
//- Construct from dictionary
|
|
faceSelection
|
|
(
|
|
const word& name,
|
|
const fvMesh& mesh,
|
|
const dictionary& dict
|
|
);
|
|
|
|
//- Clone
|
|
autoPtr<faceSelection> clone() const
|
|
{
|
|
NotImplemented;
|
|
return autoPtr<faceSelection>();
|
|
}
|
|
|
|
|
|
// Selectors
|
|
|
|
//- Return a reference to the selected faceSelection
|
|
static autoPtr<faceSelection> New
|
|
(
|
|
const word& name,
|
|
const fvMesh& mesh,
|
|
const dictionary& dict
|
|
);
|
|
|
|
|
|
//- Destructor
|
|
virtual ~faceSelection();
|
|
|
|
|
|
// Member Functions
|
|
|
|
const word& name() const
|
|
{
|
|
return name_;
|
|
}
|
|
|
|
const dictionary& dict() const
|
|
{
|
|
return dict_;
|
|
}
|
|
|
|
virtual void select(const label, labelList&, boolList&) const = 0;
|
|
|
|
};
|
|
|
|
|
|
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
|
|
|
|
} // End namespace Foam
|
|
|
|
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
|
|
|
|
#endif
|
|
|
|
// ************************************************************************* //
|