The primary variable switch controlling the phase presence state variable. More...

#include <dumux/porousmediumflow/compositional/primaryvariableswitch.hh>

Inheritance diagram for Dumux::PrimaryVariableSwitch< Implementation >:

Description

template<class Implementation>
class Dumux::PrimaryVariableSwitch< Implementation >

The primary variable switch controlling the phase presence state variable.

Public Member Functions
	PrimaryVariableSwitch (int verbosity=1)

bool	wasSwitched (std::size_t dofIdxGlobal) const
	If the primary variables were recently switched. More...

void	reset (const std::size_t numDofs)
	Reset all flags. More...

template<class SolutionVector , class GridVariables , class Problem >
bool	update (SolutionVector &curSol, GridVariables &gridVariables, const Problem &problem, const typename GridVariables::GridGeometry &gridGeometry)
	Updates the variable switch / phase presence. More...

template<class Problem , class GridVariables , class SolutionVector , std::enable_if_t< GridVariables::GridVolumeVariables::cachingEnabled, int > = 0>
void	updateSwitchedVolVars (const Problem &problem, const typename GridVariables::GridGeometry::GridView::template Codim< 0 >::Entity &element, const typename GridVariables::GridGeometry &gridGeometry, GridVariables &gridVariables, const SolutionVector &sol)
	Updates the volume variables whose primary variables were switched. More...

template<class Problem , class GridVariables , class SolutionVector , std::enable_if_t<(GridVariables::GridFluxVariablesCache::cachingEnabled &&GridVariables::GridGeometry::discMethod !=DiscretizationMethod::box), int > = 0>
void	updateSwitchedFluxVarsCache (const Problem &problem, const typename GridVariables::GridGeometry::GridView::template Codim< 0 >::Entity &element, const typename GridVariables::GridGeometry &gridGeometry, GridVariables &gridVariables, const SolutionVector &sol)
	Updates the fluxVars cache for dof whose primary variables were switched. More...

template<class Problem , class GridVariables , class SolutionVector , std::enable_if_t<(GridVariables::GridGeometry::discMethod==DiscretizationMethod::box), int > = 0>
void	updateBoundary (const Problem &problem, const typename GridVariables::GridGeometry &gridGeometry, GridVariables &gridVariables, SolutionVector &sol)
	Updates the the primary variables state at the boundary. More...

template<class Problem , class GridVariables , class SolutionVector , std::enable_if_t<!GridVariables::GridVolumeVariables::cachingEnabled, int > = 0>
void	updateSwitchedVolVars (const Problem &problem, const typename GridVariables::GridGeometry::GridView::template Codim< 0 >::Entity &element, const typename GridVariables::GridGeometry &gridGeometry, GridVariables &gridVariables, const SolutionVector &uCurrentIter) const
	Do nothing when volume variables are not cached globally. More...

template<class Problem , class GridVariables , class SolutionVector , std::enable_if_t<(!GridVariables::GridFluxVariablesCache::cachingEnabled\|\|GridVariables::GridGeometry::discMethod==DiscretizationMethod::box), int > = 0>
void	updateSwitchedFluxVarsCache (const Problem &problem, const typename GridVariables::GridGeometry::GridView::template Codim< 0 >::Entity &element, const typename GridVariables::GridGeometry &gridGeometry, GridVariables &gridVariables, const SolutionVector &sol) const
	Do nothing when flux variables are not cached globally or the box method is used. More...

template<class Problem , class GridVariables , class SolutionVector , std::enable_if_t<(GridVariables::GridGeometry::discMethod !=DiscretizationMethod::box), int > = 0>
void	updateBoundary (const Problem &problem, const typename GridVariables::GridGeometry &gridGeometry, GridVariables &gridVariables, SolutionVector &sol) const
	Do nothing when the box method is not used. More...

int	verbosity () const
	The verbosity level. More...

Protected Member Functions
Implementation &	asImp_ ()
	Return actual implementation (static polymorphism) More...

const Implementation &	asImp_ () const
	Return actual implementation (static polymorphism) More...

template<class VolumeVariables , class GlobalPosition >
bool	update_ (typename VolumeVariables::PrimaryVariables &priVars, const VolumeVariables &volVars, std::size_t dofIdxGlobal, const GlobalPosition &globalPos)

Protected Attributes
std::vector< bool >	wasSwitched_

std::vector< bool >	visited_

Constructor & Destructor Documentation

◆ PrimaryVariableSwitch()

template<class Implementation >

Dumux::PrimaryVariableSwitch< Implementation >::PrimaryVariableSwitch ( int verbosity = 1 )

inline

Member Function Documentation

◆ asImp_() [1/2]

template<class Implementation >

Implementation & Dumux::PrimaryVariableSwitch< Implementation >::asImp_ ( )

inlineprotected

Return actual implementation (static polymorphism)

◆ asImp_() [2/2]

template<class Implementation >

const Implementation & Dumux::PrimaryVariableSwitch< Implementation >::asImp_ ( ) const

inlineprotected

Return actual implementation (static polymorphism)

◆ reset()

template<class Implementation >

void Dumux::PrimaryVariableSwitch< Implementation >::reset ( const std::size_t numDofs )

inline

Reset all flags.

◆ update()

template<class Implementation >

template<class SolutionVector , class GridVariables , class Problem >

bool Dumux::PrimaryVariableSwitch< Implementation >::update	(	SolutionVector &	curSol,
		GridVariables &	gridVariables,
		const Problem &	problem,
		const typename GridVariables::GridGeometry &	gridGeometry
	)

inline

Updates the variable switch / phase presence.

Parameters

curSol	The current solution to be updated / modified
gridVariables	The secondary variables on the grid
problem	The problem
gridGeometry	The finite-volume grid geometry

◆ update_()

template<class Implementation >

template<class VolumeVariables , class GlobalPosition >

bool Dumux::PrimaryVariableSwitch< Implementation >::update_	(	typename VolumeVariables::PrimaryVariables &	priVars,
		const VolumeVariables &	volVars,
		std::size_t	dofIdxGlobal,
		const GlobalPosition &	globalPos
	)

inlineprotected

◆ updateBoundary() [1/2]

template<class Implementation >

template<class Problem , class GridVariables , class SolutionVector , std::enable_if_t<(GridVariables::GridGeometry::discMethod==DiscretizationMethod::box), int > = 0>

void Dumux::PrimaryVariableSwitch< Implementation >::updateBoundary	(	const Problem &	problem,
		const typename GridVariables::GridGeometry &	gridGeometry,
		GridVariables &	gridVariables,
		SolutionVector &	sol
	)

inline

Updates the the primary variables state at the boundary.

Required when a Dirichlet BC differes from the initial conditon (only for box method).

◆ updateBoundary() [2/2]

template<class Implementation >

template<class Problem , class GridVariables , class SolutionVector , std::enable_if_t<(GridVariables::GridGeometry::discMethod !=DiscretizationMethod::box), int > = 0>

void Dumux::PrimaryVariableSwitch< Implementation >::updateBoundary	(	const Problem &	problem,
		const typename GridVariables::GridGeometry &	gridGeometry,
		GridVariables &	gridVariables,
		SolutionVector &	sol
	)		const

inline

Do nothing when the box method is not used.

◆ updateSwitchedFluxVarsCache() [1/2]

template<class Implementation >

template<class Problem , class GridVariables , class SolutionVector , std::enable_if_t<(GridVariables::GridFluxVariablesCache::cachingEnabled &&GridVariables::GridGeometry::discMethod !=DiscretizationMethod::box), int > = 0>

void Dumux::PrimaryVariableSwitch< Implementation >::updateSwitchedFluxVarsCache	(	const Problem &	problem,
		const typename GridVariables::GridGeometry::GridView::template Codim< 0 >::Entity &	element,
		const typename GridVariables::GridGeometry &	gridGeometry,
		GridVariables &	gridVariables,
		const SolutionVector &	sol
	)

inline

Updates the fluxVars cache for dof whose primary variables were switched.

Required when flux variables are cached globally (not for box method).

◆ updateSwitchedFluxVarsCache() [2/2]

template<class Implementation >

template<class Problem , class GridVariables , class SolutionVector , std::enable_if_t<(!GridVariables::GridFluxVariablesCache::cachingEnabled||GridVariables::GridGeometry::discMethod==DiscretizationMethod::box), int > = 0>

void Dumux::PrimaryVariableSwitch< Implementation >::updateSwitchedFluxVarsCache	(	const Problem &	problem,
		const typename GridVariables::GridGeometry::GridView::template Codim< 0 >::Entity &	element,
		const typename GridVariables::GridGeometry &	gridGeometry,
		GridVariables &	gridVariables,
		const SolutionVector &	sol
	)		const

inline

Do nothing when flux variables are not cached globally or the box method is used.

◆ updateSwitchedVolVars() [1/2]

template<class Implementation >

template<class Problem , class GridVariables , class SolutionVector , std::enable_if_t< GridVariables::GridVolumeVariables::cachingEnabled, int > = 0>

void Dumux::PrimaryVariableSwitch< Implementation >::updateSwitchedVolVars	(	const Problem &	problem,
		const typename GridVariables::GridGeometry::GridView::template Codim< 0 >::Entity &	element,
		const typename GridVariables::GridGeometry &	gridGeometry,
		GridVariables &	gridVariables,
		const SolutionVector &	sol
	)

inline

Updates the volume variables whose primary variables were switched.

Required when volume variables are cached globally.

◆ updateSwitchedVolVars() [2/2]

template<class Implementation >

template<class Problem , class GridVariables , class SolutionVector , std::enable_if_t<!GridVariables::GridVolumeVariables::cachingEnabled, int > = 0>

void Dumux::PrimaryVariableSwitch< Implementation >::updateSwitchedVolVars	(	const Problem &	problem,
		const typename GridVariables::GridGeometry::GridView::template Codim< 0 >::Entity &	element,
		const typename GridVariables::GridGeometry &	gridGeometry,
		GridVariables &	gridVariables,
		const SolutionVector &	uCurrentIter
	)		const

inline

Do nothing when volume variables are not cached globally.

◆ verbosity()

template<class Implementation >

int Dumux::PrimaryVariableSwitch< Implementation >::verbosity ( ) const

inline

The verbosity level.

◆ wasSwitched()

template<class Implementation >

bool Dumux::PrimaryVariableSwitch< Implementation >::wasSwitched ( std::size_t dofIdxGlobal ) const

inline

If the primary variables were recently switched.

Member Data Documentation

◆ visited_

template<class Implementation >

std::vector<bool> Dumux::PrimaryVariableSwitch< Implementation >::visited_

protected

◆ wasSwitched_

template<class Implementation >

std::vector<bool> Dumux::PrimaryVariableSwitch< Implementation >::wasSwitched_

protected

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

compositional/primaryvariableswitch.hh

Description

Public Member Functions

Protected Member Functions

Protected Attributes

Constructor & Destructor Documentation

◆ PrimaryVariableSwitch()

Member Function Documentation

◆ asImp_() [1/2]

◆ asImp_() [2/2]

◆ reset()

◆ update()

◆ update_()

◆ updateBoundary() [1/2]

◆ updateBoundary() [2/2]

◆ updateSwitchedFluxVarsCache() [1/2]

◆ updateSwitchedFluxVarsCache() [2/2]

◆ updateSwitchedVolVars() [1/2]

◆ updateSwitchedVolVars() [2/2]

◆ verbosity()

◆ wasSwitched()

Member Data Documentation

◆ visited_

◆ wasSwitched_