mirror of
https://github.com/OpenFOAM/OpenFOAM-6.git
synced 2025-12-08 06:57:46 +00:00
To be used instead of zeroGradientFvPatchField for temporary fields for which zero-gradient extrapolation is use to evaluate the boundary field but avoiding fields derived from temporary field using field algebra inheriting the zeroGradient boundary condition by the reuse of the temporary field storage. zeroGradientFvPatchField should not be used as the default patch field for any temporary fields and should be avoided for non-temporary fields except where it is clearly appropriate; extrapolatedCalculatedFvPatchField and calculatedFvPatchField are generally more suitable defaults depending on the manner in which the boundary values are specified or evaluated. The entire OpenFOAM-dev code-base has been updated following the above recommendations. Henry G. Weller CFD Direct
150 lines
4.1 KiB
C++
150 lines
4.1 KiB
C++
/*---------------------------------------------------------------------------*\
|
|
========= |
|
|
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
|
|
\\ / O peration |
|
|
\\ / A nd | Copyright (C) 2011-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::tmp
|
|
|
|
Description
|
|
A class for managing temporary objects
|
|
|
|
SourceFiles
|
|
tmpI.H
|
|
|
|
\*---------------------------------------------------------------------------*/
|
|
|
|
#ifndef tmp_H
|
|
#define tmp_H
|
|
|
|
#include "refCount.H"
|
|
#include <cstddef>
|
|
|
|
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
|
|
|
|
namespace Foam
|
|
{
|
|
|
|
/*---------------------------------------------------------------------------*\
|
|
Class tmp Declaration
|
|
\*---------------------------------------------------------------------------*/
|
|
|
|
template<class T>
|
|
class tmp
|
|
{
|
|
// Private data
|
|
|
|
//- Flag for whether object is a temporary or a constant object
|
|
bool isTmp_;
|
|
|
|
//- Pointer to temporary object
|
|
mutable T* ptr_;
|
|
|
|
//- Const reference to constant object
|
|
const T& ref_;
|
|
|
|
|
|
public:
|
|
|
|
// Constructors
|
|
|
|
//- Store object pointer
|
|
inline explicit tmp(T* = 0);
|
|
|
|
//- Store object const reference
|
|
inline tmp(const T&);
|
|
|
|
//- Construct copy and increment reference count
|
|
inline tmp(const tmp<T>&);
|
|
|
|
//- Construct copy transferring content of temporary if required
|
|
inline tmp(const tmp<T>&, bool allowTransfer);
|
|
|
|
|
|
//- Destructor, delete object when reference count == 0
|
|
inline ~tmp();
|
|
|
|
|
|
// Member Functions
|
|
|
|
// Access
|
|
|
|
//- Return true if this is really a temporary object
|
|
inline bool isTmp() const;
|
|
|
|
//- Return true if this temporary object empty,
|
|
// ie, a temporary without allocation
|
|
inline bool empty() const;
|
|
|
|
//- Is this temporary object valid,
|
|
// ie, it is a reference or a temporary that has been allocated
|
|
inline bool valid() const;
|
|
|
|
// Edit
|
|
|
|
//- Return tmp pointer for reuse.
|
|
// Returns a clone if the object is not a temporary
|
|
inline T* ptr() const;
|
|
|
|
//- If object pointer points to valid object:
|
|
// delete object and set pointer to NULL
|
|
inline void clear() const;
|
|
|
|
|
|
// Member operators
|
|
|
|
//- Dereference operator
|
|
inline T& operator()();
|
|
|
|
//- Const dereference operator
|
|
inline const T& operator()() const;
|
|
|
|
//- Const cast to the underlying type reference
|
|
inline operator const T&() const;
|
|
|
|
//- Return object pointer
|
|
inline T* operator->();
|
|
|
|
//- Return const object pointer
|
|
inline const T* operator->() const;
|
|
|
|
//- Assignment to pointer changing this tmp to a temporary T
|
|
inline void operator=(T*);
|
|
|
|
//- Assignment transfering the temporary T to this tmp
|
|
inline void operator=(const tmp<T>&);
|
|
};
|
|
|
|
|
|
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
|
|
|
|
} // End namespace Foam
|
|
|
|
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
|
|
|
|
#include "tmpI.H"
|
|
|
|
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
|
|
|
|
#endif
|
|
|
|
// ************************************************************************* //
|