version 3.9-dev
Dumux::PrimaryVariableSwitchAdapter< Variables, isValid > Class Template Reference

An adapter for the Newton to manage models with primary variable switch.

#include <dumux/nonlinear/primaryvariableswitchadapter.hh>

Public Member Functions

 PrimaryVariableSwitchAdapter (const std::string &paramGroup="")
 
template<class SolutionVector >
void initialize (SolutionVector &sol, Variables &vars)
 Initialize the privar switch. More...
 
template<class SolutionVector >
void invoke (SolutionVector &uCurrentIter, Variables &vars)
 Switch primary variables if necessary. More...
 
bool switched () const
 Whether the primary variables have been switched in the last call to invoke. More...
 

Constructor & Destructor Documentation

◆ PrimaryVariableSwitchAdapter()

template<class Variables , bool isValid = hasPriVarsSwitch<Variables>>
Dumux::PrimaryVariableSwitchAdapter< Variables, isValid >::PrimaryVariableSwitchAdapter ( const std::string &  paramGroup = "")
inline

Member Function Documentation

◆ initialize()

template<class Variables , bool isValid = hasPriVarsSwitch<Variables>>
template<class SolutionVector >
void Dumux::PrimaryVariableSwitchAdapter< Variables, isValid >::initialize ( SolutionVector &  sol,
Variables &  vars 
)
inline

◆ invoke()

template<class Variables , bool isValid = hasPriVarsSwitch<Variables>>
template<class SolutionVector >
void Dumux::PrimaryVariableSwitchAdapter< Variables, isValid >::invoke ( SolutionVector &  uCurrentIter,
Variables &  vars 
)
inline

◆ switched()

template<class Variables , bool isValid = hasPriVarsSwitch<Variables>>
bool Dumux::PrimaryVariableSwitchAdapter< Variables, isValid >::switched ( ) const
inline

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