DuMuX: Dumux::FluidStateAdapter< FluidState, AdapterPolicy > Class Template Reference

3.2-git

DUNE for Multi-{Phase, Component, Scale, Physics, ...} flow and transport in porous media

Adapter class for fluid states with different indices. More...

#include <dumux/material/fluidstates/adapter.hh>

Description

template<class FluidState, class AdapterPolicy>
class Dumux::FluidStateAdapter< FluidState, AdapterPolicy >

Adapter class for fluid states with different indices.

Template Parameters

FluidState	the fluid state that is adapted to another fluid state's index set
AdapterPolicy

Note: This is useful when writing a fluid system that has another fluid system as an ingredient To forward to the other fluid system (which variables to be sorted according to its own indices) create the fluid state adapter of the fluid state to forward and pass the adapter to this fluid state. You need to provide an adapter policy which maps the phase and component indices from the embedded fluid system's indices to the actual fluid system's indices.

Public Types
using	Scalar = typename FluidState::Scalar
	export scalar type More...

Public Member Functions
	FluidStateAdapter (const FluidState &fluidState)
	Adapter class for fluid states with different indices. More...

Static Public Attributes
static constexpr int	numPhases = FluidSystem::numPhases
	export number of phases and components of the embedded fluid system More...

static constexpr int	numComponents = FluidSystem::numComponents

Member functions forwarding to the fluid state mapping the indices
int	wettingPhase () const

Scalar	moleFraction (int phaseIdx, int compIdx) const

Scalar	massFraction (int phaseIdx, int compIdx) const

Scalar	averageMolarMass (int phaseIdx) const

Scalar	pressure (int phaseIdx) const

Scalar	partialPressure (int phaseIdx, int compIdx) const

Scalar	temperature (int phaseIdx) const

Scalar	temperature () const

Member Typedef Documentation

◆ Scalar

template<class FluidState , class AdapterPolicy >

using Dumux::FluidStateAdapter< FluidState, AdapterPolicy >::Scalar = typename FluidState::Scalar

export scalar type

Member Function Documentation

◆ averageMolarMass()

template<class FluidState , class AdapterPolicy >

Scalar Dumux::FluidStateAdapter< FluidState, AdapterPolicy >::averageMolarMass ( int phaseIdx ) const

inline

◆ massFraction()

template<class FluidState , class AdapterPolicy >

Scalar Dumux::FluidStateAdapter< FluidState, AdapterPolicy >::massFraction	(	int	phaseIdx,
		int	compIdx
	)		const

inline

◆ moleFraction()

template<class FluidState , class AdapterPolicy >

Scalar Dumux::FluidStateAdapter< FluidState, AdapterPolicy >::moleFraction	(	int	phaseIdx,
		int	compIdx
	)		const

inline

◆ partialPressure()

template<class FluidState , class AdapterPolicy >

Scalar Dumux::FluidStateAdapter< FluidState, AdapterPolicy >::partialPressure	(	int	phaseIdx,
		int	compIdx
	)		const

inline

◆ pressure()

template<class FluidState , class AdapterPolicy >

Scalar Dumux::FluidStateAdapter< FluidState, AdapterPolicy >::pressure ( int phaseIdx ) const

inline

◆ temperature() [1/2]

template<class FluidState , class AdapterPolicy >

Scalar Dumux::FluidStateAdapter< FluidState, AdapterPolicy >::temperature ( ) const

inline

◆ temperature() [2/2]

template<class FluidState , class AdapterPolicy >

Scalar Dumux::FluidStateAdapter< FluidState, AdapterPolicy >::temperature ( int phaseIdx ) const

inline

◆ wettingPhase()

template<class FluidState , class AdapterPolicy >

int Dumux::FluidStateAdapter< FluidState, AdapterPolicy >::wettingPhase ( ) const

inline

Member Data Documentation

◆ numComponents

template<class FluidState , class AdapterPolicy >

constexpr int Dumux::FluidStateAdapter< FluidState, AdapterPolicy >::numComponents = FluidSystem::numComponents

staticconstexpr

◆ numPhases

template<class FluidState , class AdapterPolicy >

constexpr int Dumux::FluidStateAdapter< FluidState, AdapterPolicy >::numPhases = FluidSystem::numPhases

staticconstexpr

export number of phases and components of the embedded fluid system

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

adapter.hh