MooseADWrapperBase< T, S > Class Template Reference

#include <MooseADWrapper.h>

Public Types
typedef S	DNType

Public Member Functions
	MooseADWrapperBase ()
	MooseADWrapperBase (MooseADWrapperBase< T, S > &&)=default
virtual	~MooseADWrapperBase ()=default
const T &	value () const
	Returns the value for any case where a MaterialProperty is requested as a regular (non-AD) property. More...
T &	value ()
	Returns the value for any case where a MaterialProperty is declared as a regular (non-AD) property (used only during material calculations) More...
MooseADWrapperBase< T, S > &	operator= (const MooseADWrapperBase< T, S > &rhs)
MooseADWrapperBase< T, S > &	operator= (MooseADWrapperBase< T, S > &&)=default
virtual const DNType &	dn (bool=true) const
	Returns the dual number for any case where a MaterialProperty is requested as a AD property. More...
virtual DNType &	dn (bool=true)
	Returns the value for any case where a MaterialProperty is declared as an AD property (used only during material calculations) More...
void	synchronizeToVal () const
void	synchronizeToDual () const

Protected Member Functions
virtual void	initializeDual () const =0
virtual void	copyDualNumberToValue () const =0
virtual void	copyValueToDualNumber () const =0

Protected Attributes
T	_val
std::unique_ptr< DNType >	_dual_number = nullptr

Private Attributes
bool	_dual_is_dirty = true
bool	_val_is_dirty = false

Detailed Description

template<typename T, typename S>
class MooseADWrapperBase< T, S >

Definition at line 36 of file MooseADWrapper.h.

Member Typedef Documentation

DNType

template<typename T, typename S>

typedef S MooseADWrapperBase< T, S >::DNType

Definition at line 39 of file MooseADWrapper.h.

Constructor & Destructor Documentation

MooseADWrapperBase() [1/2]

template<typename T, typename S>

MooseADWrapperBase< T, S >::MooseADWrapperBase ( )

inline

Definition at line 41 of file MooseADWrapper.h.

: _val() {}

MooseADWrapperBase() [2/2]

template<typename T, typename S>

MooseADWrapperBase< T, S >::MooseADWrapperBase ( MooseADWrapperBase< T, S > &&  )

default

~MooseADWrapperBase()

template<typename T, typename S>

virtual MooseADWrapperBase< T, S >::~MooseADWrapperBase ( )

virtualdefault

Member Function Documentation

copyDualNumberToValue()

template<typename T, typename S>

virtual void MooseADWrapperBase< T, S >::copyDualNumberToValue ( ) const

protectedpure virtual

Implemented in MooseADWrapper< std::vector< DenseMatrix< Real > > >, MooseADWrapper< std::vector< DenseVector< Real > > >, MooseADWrapper< DenseMatrix< Real > >, MooseADWrapper< DenseVector< Real > >, MooseADWrapper< RankFourTensorTempl< Real > >, MooseADWrapper< RankThreeTensorTempl< Real > >, MooseADWrapper< RankTwoTensorTempl< Real > >, MooseADWrapper< TensorValue< Real > >, MooseADWrapper< VectorValue< Real > >, MooseADWrapper< Real >, and MooseADWrapper< T >.

Referenced by MooseADWrapperBase< TensorValue< Real >, TensorValue< DualReal > >::synchronizeToVal().

copyValueToDualNumber()

template<typename T, typename S>

virtual void MooseADWrapperBase< T, S >::copyValueToDualNumber ( ) const

protectedpure virtual

Implemented in MooseADWrapper< std::vector< DenseMatrix< Real > > >, MooseADWrapper< std::vector< DenseVector< Real > > >, MooseADWrapper< DenseMatrix< Real > >, MooseADWrapper< DenseVector< Real > >, MooseADWrapper< RankFourTensorTempl< Real > >, MooseADWrapper< RankThreeTensorTempl< Real > >, MooseADWrapper< RankTwoTensorTempl< Real > >, MooseADWrapper< TensorValue< Real > >, MooseADWrapper< VectorValue< Real > >, MooseADWrapper< Real >, and MooseADWrapper< T >.

Referenced by MooseADWrapperBase< TensorValue< Real >, TensorValue< DualReal > >::operator=(), and MooseADWrapperBase< TensorValue< Real >, TensorValue< DualReal > >::synchronizeToDual().

dn() [1/2]

template<typename T, typename S>

virtual DNType& MooseADWrapperBase< T, S >::dn ( bool  = true )

inlinevirtual

Returns the value for any case where a MaterialProperty is declared as an AD property (used only during material calculations)

Reimplemented in MooseADWrapper< T >.

Definition at line 91 of file MooseADWrapper.h.

  {
    synchronizeToDual();
    _val_is_dirty = true;
    return *_dual_number;
  }

dn() [2/2]

template<typename T, typename S>

virtual const DNType& MooseADWrapperBase< T, S >::dn ( bool  = true ) const

inlinevirtual

Returns the dual number for any case where a MaterialProperty is requested as a AD property.

Reimplemented in MooseADWrapper< T >.

Definition at line 81 of file MooseADWrapper.h.

  {
    synchronizeToDual();
    return *_dual_number;
  }

Referenced by MooseADWrapper< T >::dn().

initializeDual()

template<typename T, typename S>

virtual void MooseADWrapperBase< T, S >::initializeDual ( ) const

protectedpure virtual

Implemented in MooseADWrapper< std::vector< DenseMatrix< Real > > >, MooseADWrapper< std::vector< DenseVector< Real > > >, MooseADWrapper< DenseMatrix< Real > >, MooseADWrapper< DenseVector< Real > >, MooseADWrapper< RankFourTensorTempl< Real > >, MooseADWrapper< RankThreeTensorTempl< Real > >, MooseADWrapper< RankTwoTensorTempl< Real > >, MooseADWrapper< TensorValue< Real > >, MooseADWrapper< VectorValue< Real > >, MooseADWrapper< Real >, and MooseADWrapper< T >.

Referenced by MooseADWrapperBase< TensorValue< Real >, TensorValue< DualReal > >::synchronizeToDual(), and MooseADWrapperBase< TensorValue< Real >, TensorValue< DualReal > >::synchronizeToVal().

operator=() [1/2]

template<typename T, typename S>

MooseADWrapperBase<T, S>& MooseADWrapperBase< T, S >::operator= ( const MooseADWrapperBase< T, S > &  rhs )

inline

Definition at line 66 of file MooseADWrapper.h.

  {
    _val = rhs._val;
    if (_dual_number && rhs._dual_number)
      *_dual_number = *rhs._dual_number;
    else if (_dual_number)
      copyValueToDualNumber();
    return *this;
  }

operator=() [2/2]

template<typename T, typename S>

MooseADWrapperBase<T, S>& MooseADWrapperBase< T, S >::operator= ( MooseADWrapperBase< T, S > &&  )

default

synchronizeToDual()

template<typename T, typename S>

void MooseADWrapperBase< T, S >::synchronizeToDual ( ) const

inline

Definition at line 112 of file MooseADWrapper.h.

  {
    mooseAssert(!(_dual_is_dirty && _val_is_dirty),
                "dual/non-dual material property synchronization is broken");
    if (!_dual_is_dirty)
      return;
 
    if (!_dual_number)
      initializeDual();
    if (_dual_number)
      copyValueToDualNumber();
    _dual_is_dirty = false;
  }

Referenced by MooseADWrapperBase< TensorValue< Real >, TensorValue< DualReal > >::dn().

synchronizeToVal()

template<typename T, typename S>

void MooseADWrapperBase< T, S >::synchronizeToVal ( ) const

inline

Definition at line 98 of file MooseADWrapper.h.

  {
    mooseAssert(!(_dual_is_dirty && _val_is_dirty),
                "dual/non-dual material property synchronization is broken");
    if (!_val_is_dirty)
      return;
 
    if (!_dual_number)
      initializeDual();
    if (_dual_number)
      copyDualNumberToValue();
    _val_is_dirty = false;
  }

Referenced by MooseADWrapperBase< TensorValue< Real >, TensorValue< DualReal > >::value().

value() [1/2]

template<typename T, typename S>

T& MooseADWrapperBase< T, S >::value ( )

inline

Returns the value for any case where a MaterialProperty is declared as a regular (non-AD) property (used only during material calculations)

Definition at line 59 of file MooseADWrapper.h.

  {
    synchronizeToVal();
    _dual_is_dirty = true;
    return _val;
  }

value() [2/2]

template<typename T, typename S>

const T& MooseADWrapperBase< T, S >::value ( ) const

inline

Returns the value for any case where a MaterialProperty is requested as a regular (non-AD) property.

Definition at line 49 of file MooseADWrapper.h.

  {
    synchronizeToVal();
    return _val;
  }

Referenced by MooseADWrapper< std::vector< DenseMatrix< Real > > >::copyDualNumberToValue().

Member Data Documentation

_dual_is_dirty

template<typename T, typename S>

bool MooseADWrapperBase< T, S >::_dual_is_dirty = true

mutableprivate

Definition at line 135 of file MooseADWrapper.h.

Referenced by MooseADWrapperBase< TensorValue< Real >, TensorValue< DualReal > >::synchronizeToDual(), MooseADWrapperBase< TensorValue< Real >, TensorValue< DualReal > >::synchronizeToVal(), and MooseADWrapperBase< TensorValue< Real >, TensorValue< DualReal > >::value().

_dual_number

template<typename T, typename S>

std::unique_ptr<DNType> MooseADWrapperBase< T, S >::_dual_number = nullptr

mutableprotected

Definition at line 132 of file MooseADWrapper.h.

Referenced by MooseADWrapperBase< TensorValue< Real >, TensorValue< DualReal > >::dn(), MooseADWrapperBase< TensorValue< Real >, TensorValue< DualReal > >::operator=(), MooseADWrapperBase< TensorValue< Real >, TensorValue< DualReal > >::synchronizeToDual(), and MooseADWrapperBase< TensorValue< Real >, TensorValue< DualReal > >::synchronizeToVal().

_val

template<typename T, typename S>

T MooseADWrapperBase< T, S >::_val

mutableprotected

Definition at line 131 of file MooseADWrapper.h.

Referenced by MooseADWrapperBase< TensorValue< Real >, TensorValue< DualReal > >::operator=(), and MooseADWrapperBase< TensorValue< Real >, TensorValue< DualReal > >::value().

_val_is_dirty

template<typename T, typename S>

bool MooseADWrapperBase< T, S >::_val_is_dirty = false

mutableprivate

Definition at line 136 of file MooseADWrapper.h.

Referenced by MooseADWrapperBase< TensorValue< Real >, TensorValue< DualReal > >::dn(), MooseADWrapperBase< TensorValue< Real >, TensorValue< DualReal > >::synchronizeToDual(), and MooseADWrapperBase< TensorValue< Real >, TensorValue< DualReal > >::synchronizeToVal().

---

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

• include/utils/MooseADWrapper.h