PrecisionAdaptor< Type, InputType, Container > Class Template Reference

A non-const Field/List wrapper with possible data conversion. More...

Inheritance diagram for PrecisionAdaptor< Type, InputType, Container >:
[legend]
Collaboration diagram for PrecisionAdaptor< Type, InputType, Container >:
[legend]

Public Types

typedef Container< Type > FieldType
 The adapted field type. Same as element_type. More...
 
- Public Types inherited from refPtr< Container< Type > >
typedef Container< Type > element_type
 Type of object being managed or referenced. More...
 
typedef Container< Type > * pointer
 Pointer to type of object being managed or referenced. More...
 
typedef Foam::refCount::zero refCount
 Null reference counter class. More...
 

Public Member Functions

 PrecisionAdaptor ()=default
 Default construct, setting content later. More...
 
 PrecisionAdaptor (Container< InputType > &input, const bool doCopy=true)
 
 ~PrecisionAdaptor ()
 Destructor, copies back content changes (as required) More...
 
bool active () const noexcept
 Is precision adaption being used (non-passive adaptor)? More...
 
void commit ()
 Commit adapted content changes back to original input (as required) More...
 
void set (Container< InputType > &input, const bool doCopy=true)
 Set adaptor for different input, copying input as required. More...
 
- Public Member Functions inherited from refPtr< Container< Type > >
Foam::refPtr< Container< Type > > New (Args &&... args)
 
Foam::refPtr< Container< Type > > NewFrom (Args &&... args)
 
constexpr refPtr () noexcept
 Construct with no managed pointer. More...
 
constexpr refPtr (std::nullptr_t) noexcept
 Construct with no managed pointer (literal nullptr). More...
 
constexpr refPtr (Container< Type > *p) noexcept
 Construct, taking ownership of the pointer. More...
 
 refPtr (autoPtr< Container< Type > > &&ptr) noexcept
 Move construct from autoPtr, transferring ownership. More...
 
 refPtr (std::unique_ptr< Container< Type > > &&ptr) noexcept
 Move construct from unique_ptr, transferring ownership. More...
 
constexpr refPtr (const Container< Type > &obj) noexcept
 Construct for a const reference to an object. More...
 
 refPtr (refPtr< Container< Type > > &&rhs) noexcept
 Move construct, transferring ownership. More...
 
 refPtr (const refPtr< Container< Type > > &rhs)
 Copy construct (shallow copy) More...
 
 refPtr (const refPtr< Container< Type > > &rhs, bool reuse)
 Copy/move construct. Optionally reusing pointer. More...
 
 ~refPtr ()
 Destructor: deletes managed pointer. More...
 
bool good () const noexcept
 True if pointer/reference is non-null. More...
 
bool is_const () const noexcept
 If the stored/referenced content is const. More...
 
bool is_pointer () const noexcept
 True if this is a managed pointer (not a reference) More...
 
bool movable () const noexcept
 True if this is a non-null managed pointer. More...
 
Container< Type > * get () noexcept
 Return pointer without nullptr checking. More...
 
const Container< Type > * get () const noexcept
 Return const pointer without nullptr checking. More...
 
const Container< Type > & cref () const
 
void cref (const refPtr< Container< Type > > &other) noexcept
 Clear existing and set (const) reference from other. More...
 
void cref (const Container< Type > &obj) noexcept
 Clear existing and set (const) reference. More...
 
void cref (const Container< Type > *p) noexcept
 Clear existing and set (const) reference to pointer content. More...
 
Container< Type > & ref () const
 
void ref (Container< Type > &obj) noexcept
 Clear existing and set (non-const) reference. More...
 
void ref (Container< Type > *p) noexcept
 Clear existing and set (non-const) reference to pointer content. More...
 
Container< Type > & constCast () const
 
refPtr< Container< Type > > shallowClone () const noexcept
 
Container< Type > * release () noexcept
 
Container< Type > * ptr () const
 Return managed pointer for reuse, or clone() the object reference. More...
 
void clear () const noexcept
 
void reset (refPtr< Container< Type > > &&other) noexcept
 Clear existing and transfer ownership. More...
 
void reset (Container< Type > *p=nullptr) noexcept
 Delete managed pointer and set to new given pointer. More...
 
void reset (autoPtr< Container< Type > > &&other) noexcept
 Clear existing and transfer ownership from autoPtr. More...
 
void reset (std::unique_ptr< Container< Type > > &&other)
 Clear existing and transfer ownership from unique_ptr. More...
 
void swap (refPtr< Container< Type > > &other) noexcept
 Swaps the managed object with other. More...
 
const Container< Type > & operator* () const
 Return const reference to the object. More...
 
Container< Type > & operator* ()
 Return reference to the managed object. More...
 
const Container< Type > * operator-> () const
 Dereferences (const) pointer to the managed object. More...
 
Container< Type > * operator-> ()
 Dereferences (non-const) pointer to the managed object. More...
 
const Container< Type > & operator() () const
 Return const reference to the object - same as cref() method. More...
 
 operator bool () const noexcept
 True if pointer/reference is non-null. Same as good() More...
 
 operator const Container< Type > & () const
 Cast to underlying data type, using the cref() method. More...
 
void operator= (const refPtr< Container< Type > > &other)
 Transfer ownership of the managed pointer. More...
 
void operator= (refPtr< Container< Type > > &&other) noexcept
 Clear existing and transfer ownership. More...
 
void operator= (Container< Type > *p)
 Take ownership of the pointer. More...
 
void operator= (std::nullptr_t) noexcept
 Reset via assignment from literal nullptr. More...
 
 operator tmp< Container< Type > > ()
 Conversion to tmp, releases pointer or shallow-copies reference. More...
 
bool valid () const noexcept
 Identical to good(), or bool operator. More...
 
bool empty () const noexcept
 Deprecated(2020-07) True if a null managed pointer. More...
 

Additional Inherited Members

- Static Public Member Functions inherited from refPtr< Container< Type > >
static refPtr< Container< Type > > New (Args &&... args)
 Construct refPtr of T with forwarding arguments. More...
 
static refPtr< Container< Type > > NewFrom (Args &&... args)
 Construct refPtr from derived type with forwarding arguments. More...
 
static word typeName ()
 The type-name, constructed from type-name of T. More...
 

Detailed Description

template<class Type, class InputType, template< class > class Container = Field>
class Foam::PrecisionAdaptor< Type, InputType, Container >

A non-const Field/List wrapper with possible data conversion.

Conversion adaptor for Field/List that either wrap the input as a reference, or creates a temporary pointer and copies the values on construction/destruction.

This provides, for example, automatic conversion between types for linear solvers able to run mixed precision.

Definition at line 186 of file PrecisionAdaptor.H.

Member Typedef Documentation

◆ FieldType

typedef Container<Type> FieldType

The adapted field type. Same as element_type.

Definition at line 221 of file PrecisionAdaptor.H.

Constructor & Destructor Documentation

◆ PrecisionAdaptor() [1/2]

PrecisionAdaptor ( )
default

Default construct, setting content later.

◆ PrecisionAdaptor() [2/2]

PrecisionAdaptor ( Container< InputType > &  input,
const bool  doCopy = true 
)
inlineexplicit

Construct from Container<InputType>, copying input if required (and requested)

Definition at line 232 of file PrecisionAdaptor.H.

References Foam::input().

Here is the call graph for this function:

◆ ~PrecisionAdaptor()

~PrecisionAdaptor ( )
inline

Destructor, copies back content changes (as required)

Definition at line 242 of file PrecisionAdaptor.H.

References refPtr< Container< Type > >::clear(), and PrecisionAdaptor< Type, InputType, Container >::commit().

Here is the call graph for this function:

Member Function Documentation

◆ active()

bool active ( ) const
inlinenoexcept

Is precision adaption being used (non-passive adaptor)?

Definition at line 252 of file PrecisionAdaptor.H.

References refPtr< Container< Type > >::good(), and refPtr< Container< Type > >::is_pointer().

Referenced by PrecisionAdaptor< Type, InputType, Container >::commit().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ commit()

void commit ( )
inline

Commit adapted content changes back to original input (as required)

Definition at line 259 of file PrecisionAdaptor.H.

References PrecisionAdaptor< Type, InputType, Container >::active(), refPtr< Container< Type > >::cref(), refPtr< T >::good(), Foam::input(), and refPtr< T >::ref().

Referenced by PrecisionAdaptor< Type, InputType, Container >::set(), and PrecisionAdaptor< Type, InputType, Container >::~PrecisionAdaptor().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ set()

void set ( Container< InputType > &  input,
const bool  doCopy = true 
)
inline

Set adaptor for different input, copying input as required.

Definition at line 271 of file PrecisionAdaptor.H.

References PrecisionAdaptor< Type, InputType, Container >::commit(), refPtr< T >::get(), and Foam::input().

Here is the call graph for this function:

The documentation for this class was generated from the following file: