Alsvinn  0.5.3
The fast FVM simulator with UQ support
Public Types | Public Member Functions | List of all members
alsfvm::volume::VolumePair Class Reference

Easy reference to the combination of conserved volume and extra volume. More...

#include <alsfvm/volume/VolumePair.hpp>

Public Types

typedef std::vector< std::shared_ptr< volume::Volume > >::iterator IteratorType
 
typedef std::vector< std::shared_ptr< volume::Volume > >::const_iterator ConstIteratorType
 

Public Member Functions

 VolumePair ()
 
 VolumePair (std::shared_ptr< volume::Volume > conservedVolume, std::shared_ptr< volume::Volume > extraVolume)
 
 VolumePair (std::shared_ptr< volume::Volume > conservedVolume)
 
std::shared_ptr< volume::VolumegetConservedVolume ()
 
std::shared_ptr< volume::VolumegetExtraVolume ()
 
IteratorType begin ()
 
IteratorType end ()
 
ConstIteratorType begin () const
 
ConstIteratorType end () const
 

Detailed Description

Easy reference to the combination of conserved volume and extra volume.

Member Typedef Documentation

◆ ConstIteratorType

typedef std::vector<std::shared_ptr<volume::Volume> >::const_iterator alsfvm::volume::VolumePair::ConstIteratorType

◆ IteratorType

typedef std::vector<std::shared_ptr<volume::Volume> >::iterator alsfvm::volume::VolumePair::IteratorType

Constructor & Destructor Documentation

◆ VolumePair() [1/3]

alsfvm::volume::VolumePair::VolumePair ( )
inline

◆ VolumePair() [2/3]

alsfvm::volume::VolumePair::VolumePair ( std::shared_ptr< volume::Volume conservedVolume,
std::shared_ptr< volume::Volume extraVolume 
)

◆ VolumePair() [3/3]

alsfvm::volume::VolumePair::VolumePair ( std::shared_ptr< volume::Volume conservedVolume)

Member Function Documentation

◆ begin() [1/2]

VolumePair::IteratorType alsfvm::volume::VolumePair::begin ( )

◆ begin() [2/2]

VolumePair::ConstIteratorType alsfvm::volume::VolumePair::begin ( ) const

◆ end() [1/2]

VolumePair::IteratorType alsfvm::volume::VolumePair::end ( )

◆ end() [2/2]

VolumePair::ConstIteratorType alsfvm::volume::VolumePair::end ( ) const

◆ getConservedVolume()

std::shared_ptr< Volume > alsfvm::volume::VolumePair::getConservedVolume ( )

◆ getExtraVolume()

std::shared_ptr< Volume > alsfvm::volume::VolumePair::getExtraVolume ( )

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