dbpp::FluxTensorMap Struct Reference

Map cell face and flux values. More...

#include <dbpp_FluxTensor.h>

Public Types
enum class	eFFcomp { FF1 , FF2 }
	Flux component. More...
using	sizeMapType = std::map<short, FluxTensor>::size_type
	alias

Public Member Functions
bool	insert (FluxTensor &&aFlux2Insert)
	Add a flux tensor.
std::vector< float64 >	asStdVector (const eFFcomp &aFFcomp) const
	flux component as vector
std::valarray< float64 >	asStdValArray (const eFFcomp &aFFcomp) const
	flux component as valarray
bool	isNullValues (const eFFcomp &aFFcomp) const
	check for null values
bool	hasNAN (const eFFcomp &aFFcomp) const
	check for nan values
std::optional< FluxTensor >	operator[] (short aIdx) const
	element accessor
sizeMapType	size () const noexcept
	number of element
bool	isEmpty () const noexcept
	check for emptiness
void	clear () noexcept
	resize

Public Attributes
std::map< short, FluxTensor >	m_fluxTensorMap

Detailed Description

Map cell face and flux values.

Member Typedef Documentation

sizeMapType

using dbpp::FluxTensorMap::sizeMapType = std::map<short, FluxTensor>::size_type

alias

Member Enumeration Documentation

eFFcomp

enum class dbpp::FluxTensorMap::eFFcomp

strong

Flux component.

Enumerator
FF1
FF2

Member Function Documentation

asStdValArray()

std::valarray< float64 > dbpp::FluxTensorMap::asStdValArray ( const eFFcomp & aFFcomp ) const

inline

flux component as valarray

Parameters

aFFcomp

flux component

Returns

valarray

asStdVector()

std::vector< float64 > dbpp::FluxTensorMap::asStdVector ( const eFFcomp & aFFcomp ) const

inline

flux component as vector

Parameters

aFFcomp

flux component

Returns

vector

clear()

void dbpp::FluxTensorMap::clear ( )

inlinenoexcept

resize

hasNAN()

bool dbpp::FluxTensorMap::hasNAN ( const eFFcomp & aFFcomp ) const

inline

check for nan values

Parameters

aFFcomp

flux component

Returns

true/false

insert()

bool dbpp::FluxTensorMap::insert ( FluxTensor && aFlux2Insert )

inline

Add a flux tensor.

isEmpty()

bool dbpp::FluxTensorMap::isEmpty ( ) const

inlinenodiscardnoexcept

check for emptiness

Returns

true/false

isNullValues()

bool dbpp::FluxTensorMap::isNullValues ( const eFFcomp & aFFcomp ) const

inline

check for null values

Parameters

aFFcomp

flux component

Returns

true/false

operator[]()

std::optional< FluxTensor > dbpp::FluxTensorMap::operator[] ( short aIdx ) const

inline

element accessor

Parameters

aIdx	element index

Returns

optional value

size()

sizeMapType dbpp::FluxTensorMap::size ( ) const

inlinenoexcept

number of element

Returns

size_t

Member Data Documentation

m_fluxTensorMap

std::map<short, FluxTensor> dbpp::FluxTensorMap::m_fluxTensorMap

---

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

• DamBreakSimulator/Nov_VS2019/dbpp_FluxTensor.h