viennals::OxidationModel< T, D > Class Template Reference

Iterates diffusion, oxide deformation, and pressure-dependent reaction-rate feedback on the shared Cartesian solve grid. More...

#include <lsOxidationModel.hpp>

Public Member Functions
	OxidationModel ()=default
	OxidationModel (SmartPointer< OxidationDiffusion< T, D > > passedDiffusionField, SmartPointer< OxidationDeformation< T, D > > passedDeformationField, OxidationCouplingParameters passedParameters={})
void	setDiffusionField (SmartPointer< OxidationDiffusion< T, D > > passedDiffusionField)
void	setDeformationField (SmartPointer< OxidationDeformation< T, D > > passedDeformationField)
void	setParameters (OxidationCouplingParameters passedParameters)
void	setSolveBounds (const IndexType &passedMinIndex, const IndexType &passedMaxIndex)
void	clearSolveBounds ()
void	apply ()
unsigned	getIterations () const
T	getResidual () const
bool	hasConverged () const
std::string	getFailureReason () const

Static Public Member Functions
template<class... Args>
static auto	New (Args &&...args)

Detailed Description

template<class T, int D>
class viennals::OxidationModel< T, D >

Iterates diffusion, oxide deformation, and pressure-dependent reaction-rate feedback on the shared Cartesian solve grid.

Constructor & Destructor Documentation

OxidationModel() [1/2]

template<class T, int D>

viennals::OxidationModel< T, D >::OxidationModel ( )

default

OxidationModel() [2/2]

template<class T, int D>

viennals::OxidationModel< T, D >::OxidationModel ( SmartPointer< OxidationDiffusion< T, D > > passedDiffusionField, SmartPointer< OxidationDeformation< T, D > > passedDeformationField, OxidationCouplingParameters passedParameters = {} )

inline

Member Function Documentation

apply()

template<class T, int D>

void viennals::OxidationModel< T, D >::apply ( )

inline

clearSolveBounds()

template<class T, int D>

void viennals::OxidationModel< T, D >::clearSolveBounds ( )

inline

getFailureReason()

template<class T, int D>

std::string viennals::OxidationModel< T, D >::getFailureReason ( ) const

inline

getIterations()

template<class T, int D>

unsigned viennals::OxidationModel< T, D >::getIterations ( ) const

inline

getResidual()

template<class T, int D>

T viennals::OxidationModel< T, D >::getResidual ( ) const

inline

hasConverged()

template<class T, int D>

bool viennals::OxidationModel< T, D >::hasConverged ( ) const

inline

New()

template<class T, int D>

template<class... Args>

auto viennals::OxidationModel< T, D >::New ( Args &&... args )

inlinestatic

setDeformationField()

template<class T, int D>

void viennals::OxidationModel< T, D >::setDeformationField ( SmartPointer< OxidationDeformation< T, D > > passedDeformationField )

inline

setDiffusionField()

template<class T, int D>

void viennals::OxidationModel< T, D >::setDiffusionField ( SmartPointer< OxidationDiffusion< T, D > > passedDiffusionField )

inline

setParameters()

template<class T, int D>

void viennals::OxidationModel< T, D >::setParameters ( OxidationCouplingParameters passedParameters )

inline

setSolveBounds()

template<class T, int D>

void viennals::OxidationModel< T, D >::setSolveBounds ( const IndexType & passedMinIndex, const IndexType & passedMaxIndex )

inline

---

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

• include/viennals/lsOxidationModel.hpp