#include <FlagInfo.h>

Public Types
using	flag_t = typename FlagField_T::flag_t

Public Member Functions
	FlagInfo ()
	FlagInfo (const Set< field::FlagUID > &obstacleIDs, const Set< field::FlagUID > &outflowIDs=Set< field::FlagUID >::emptySet(), const Set< field::FlagUID > &inflowIDs=Set< field::FlagUID >::emptySet(), const Set< field::FlagUID > &freeSlipIDs=Set< field::FlagUID >::emptySet())
bool	operator== (const FlagInfo &o) const
bool	operator!= (const FlagInfo &o) const
template<typename FieldItOrPtr_T>
bool	isInterface (const FieldItOrPtr_T &flagItOrPtr) const
template<typename FieldItOrPtr_T>
bool	isLiquid (const FieldItOrPtr_T &flagItOrPtr) const
template<typename FieldItOrPtr_T>
bool	isGas (const FieldItOrPtr_T &flagItOrPtr) const
template<typename FieldItOrPtr_T>
bool	isObstacle (const FieldItOrPtr_T &flagItOrPtr) const
template<typename FieldItOrPtr_T>
bool	isOutflow (const FieldItOrPtr_T &flagItOrPtr) const
template<typename FieldItOrPtr_T>
bool	isInflow (const FieldItOrPtr_T &flagItOrPtr) const
template<typename FieldItOrPtr_T>
bool	isFreeSlip (const FieldItOrPtr_T &flagItOrPtr) const
template<typename FieldItOrPtr_T>
bool	hasConverted (const FieldItOrPtr_T &flagItOrPtr) const
template<typename FieldItOrPtr_T>
bool	hasConvertedToGas (const FieldItOrPtr_T &flagItOrPtr) const
template<typename FieldItOrPtr_T>
bool	hasConvertedToLiquid (const FieldItOrPtr_T &flagItOrPtr) const
template<typename FieldItOrPtr_T>
bool	hasConvertedFromGasToInterface (const FieldItOrPtr_T &flagItOrPtr) const
template<typename FieldItOrPtr_T>
bool	isKeepInterfaceForWetting (const FieldItOrPtr_T &flagItOrPtr) const
template<typename FieldItOrPtr_T>
bool	isConvertToInterfaceForInflow (const FieldItOrPtr_T &flagItOrPtr) const
bool	isInterface (const flag_t val) const
bool	isLiquid (const flag_t val) const
bool	isGas (const flag_t val) const
bool	isObstacle (const flag_t val) const
bool	isOutflow (const flag_t val) const
bool	isInflow (const flag_t val) const
bool	isFreeSlip (const flag_t val) const
bool	isKeepInterfaceForWetting (const flag_t val) const
bool	hasConvertedToGas (const flag_t val) const
bool	hasConvertedToLiquid (const flag_t val) const
bool	hasConvertedFromGasToInterface (const flag_t val) const
bool	isConvertToInterfaceForInflow (const flag_t val) const
bool	isConsistentAcrossBlocksAndProcesses (const std::weak_ptr< StructuredBlockStorage > &blockStorage, ConstBlockDataID flagFieldID) const
void	registerFlags (FlagField_T *field) const
Set< field::FlagUID >	getObstacleIDSet () const
Set< field::FlagUID >	getOutflowIDs () const
Set< field::FlagUID >	getInflowIDs () const
Set< field::FlagUID >	getFreeSlipIDs () const

Static Public Member Functions
static void	registerFlags (FlagField_T *field, const Set< field::FlagUID > &obstacleIDs, const Set< field::FlagUID > &outflowIDs=Set< field::FlagUID >::emptySet(), const Set< field::FlagUID > &inflowIDs=Set< field::FlagUID >::emptySet(), const Set< field::FlagUID > &freeSlipIDs=Set< field::FlagUID >::emptySet())

Protected Member Functions
	FlagInfo (const FlagField_T *field, const Set< field::FlagUID > &obstacleIDs, const Set< field::FlagUID > &outflowIDs, const Set< field::FlagUID > &inflowIDs, const Set< field::FlagUID > &freeSlipIDs)

Protected Attributes
Set< field::FlagUID >	obstacleIDs_
Set< field::FlagUID >	outflowIDs_
Set< field::FlagUID >	inflowIDs_
Set< field::FlagUID >	freeSlipIDs_

Member Typedef Documentation

◆ flag_t

template<typename FlagField_T>

using walberla::free_surface::FlagInfo< FlagField_T >::flag_t = typename FlagField_T::flag_t

Constructor & Destructor Documentation

◆ FlagInfo() [1/3]

template<typename FlagField_T>

walberla::free_surface::FlagInfo< FlagField_T >::FlagInfo ( )

◆ FlagInfo() [2/3]

template<typename FlagField_T>

walberla::free_surface::FlagInfo< FlagField_T >::FlagInfo	(	const Set< field::FlagUID > &	obstacleIDs,
		const Set< field::FlagUID > &	outflowIDs = Set< field::FlagUID >::emptySet(),
		const Set< field::FlagUID > &	inflowIDs = Set< field::FlagUID >::emptySet(),
		const Set< field::FlagUID > &	freeSlipIDs = Set< field::FlagUID >::emptySet() )

◆ FlagInfo() [3/3]

template<typename FlagField_T>

walberla::free_surface::FlagInfo< FlagField_T >::FlagInfo	(	const FlagField_T *	field,
		const Set< field::FlagUID > &	obstacleIDs,
		const Set< field::FlagUID > &	outflowIDs,
		const Set< field::FlagUID > &	inflowIDs,
		const Set< field::FlagUID > &	freeSlipIDs )

protected

Member Function Documentation

◆ getFreeSlipIDs()

template<typename FlagField_T>

Set< field::FlagUID > walberla::free_surface::FlagInfo< FlagField_T >::getFreeSlipIDs ( ) const

inline

◆ getInflowIDs()

template<typename FlagField_T>

Set< field::FlagUID > walberla::free_surface::FlagInfo< FlagField_T >::getInflowIDs ( ) const

inline

◆ getObstacleIDSet()

template<typename FlagField_T>

Set< field::FlagUID > walberla::free_surface::FlagInfo< FlagField_T >::getObstacleIDSet ( ) const

inline

◆ getOutflowIDs()

template<typename FlagField_T>

Set< field::FlagUID > walberla::free_surface::FlagInfo< FlagField_T >::getOutflowIDs ( ) const

inline

◆ hasConverted()

template<typename FlagField_T>

template<typename FieldItOrPtr_T>

bool walberla::free_surface::FlagInfo< FlagField_T >::hasConverted ( const FieldItOrPtr_T & flagItOrPtr ) const

inline

◆ hasConvertedFromGasToInterface() [1/2]

template<typename FlagField_T>

template<typename FieldItOrPtr_T>

bool walberla::free_surface::FlagInfo< FlagField_T >::hasConvertedFromGasToInterface ( const FieldItOrPtr_T & flagItOrPtr ) const

inline

◆ hasConvertedFromGasToInterface() [2/2]

template<typename FlagField_T>

bool walberla::free_surface::FlagInfo< FlagField_T >::hasConvertedFromGasToInterface ( const flag_t val ) const

inline

◆ hasConvertedToGas() [1/2]

template<typename FlagField_T>

template<typename FieldItOrPtr_T>

bool walberla::free_surface::FlagInfo< FlagField_T >::hasConvertedToGas ( const FieldItOrPtr_T & flagItOrPtr ) const

inline

◆ hasConvertedToGas() [2/2]

template<typename FlagField_T>

bool walberla::free_surface::FlagInfo< FlagField_T >::hasConvertedToGas ( const flag_t val ) const

inline

◆ hasConvertedToLiquid() [1/2]

template<typename FlagField_T>

template<typename FieldItOrPtr_T>

bool walberla::free_surface::FlagInfo< FlagField_T >::hasConvertedToLiquid ( const FieldItOrPtr_T & flagItOrPtr ) const

inline

◆ hasConvertedToLiquid() [2/2]

template<typename FlagField_T>

bool walberla::free_surface::FlagInfo< FlagField_T >::hasConvertedToLiquid ( const flag_t val ) const

inline

◆ isConsistentAcrossBlocksAndProcesses()

template<typename FlagField_T>

bool walberla::free_surface::FlagInfo< FlagField_T >::isConsistentAcrossBlocksAndProcesses	(	const std::weak_ptr< StructuredBlockStorage > &	blockStorage,
		ConstBlockDataID	flagFieldID ) const

◆ isConvertToInterfaceForInflow() [1/2]

template<typename FlagField_T>

template<typename FieldItOrPtr_T>

bool walberla::free_surface::FlagInfo< FlagField_T >::isConvertToInterfaceForInflow ( const FieldItOrPtr_T & flagItOrPtr ) const

inline

◆ isConvertToInterfaceForInflow() [2/2]

template<typename FlagField_T>

bool walberla::free_surface::FlagInfo< FlagField_T >::isConvertToInterfaceForInflow ( const flag_t val ) const

inline

◆ isFreeSlip() [1/2]

template<typename FlagField_T>

template<typename FieldItOrPtr_T>

bool walberla::free_surface::FlagInfo< FlagField_T >::isFreeSlip ( const FieldItOrPtr_T & flagItOrPtr ) const

inline

◆ isFreeSlip() [2/2]

template<typename FlagField_T>

bool walberla::free_surface::FlagInfo< FlagField_T >::isFreeSlip ( const flag_t val ) const

inline

◆ isGas() [1/2]

template<typename FlagField_T>

template<typename FieldItOrPtr_T>

bool walberla::free_surface::FlagInfo< FlagField_T >::isGas ( const FieldItOrPtr_T & flagItOrPtr ) const

inline

◆ isGas() [2/2]

template<typename FlagField_T>

bool walberla::free_surface::FlagInfo< FlagField_T >::isGas ( const flag_t val ) const

inline

◆ isInflow() [1/2]

template<typename FlagField_T>

template<typename FieldItOrPtr_T>

bool walberla::free_surface::FlagInfo< FlagField_T >::isInflow ( const FieldItOrPtr_T & flagItOrPtr ) const

inline

◆ isInflow() [2/2]

template<typename FlagField_T>

bool walberla::free_surface::FlagInfo< FlagField_T >::isInflow ( const flag_t val ) const

inline

◆ isInterface() [1/2]

template<typename FlagField_T>

template<typename FieldItOrPtr_T>

bool walberla::free_surface::FlagInfo< FlagField_T >::isInterface ( const FieldItOrPtr_T & flagItOrPtr ) const

inline

◆ isInterface() [2/2]

template<typename FlagField_T>

bool walberla::free_surface::FlagInfo< FlagField_T >::isInterface ( const flag_t val ) const

inline

◆ isKeepInterfaceForWetting() [1/2]

template<typename FlagField_T>

template<typename FieldItOrPtr_T>

bool walberla::free_surface::FlagInfo< FlagField_T >::isKeepInterfaceForWetting ( const FieldItOrPtr_T & flagItOrPtr ) const

inline

◆ isKeepInterfaceForWetting() [2/2]

template<typename FlagField_T>

bool walberla::free_surface::FlagInfo< FlagField_T >::isKeepInterfaceForWetting ( const flag_t val ) const

inline

◆ isLiquid() [1/2]

template<typename FlagField_T>

template<typename FieldItOrPtr_T>

bool walberla::free_surface::FlagInfo< FlagField_T >::isLiquid ( const FieldItOrPtr_T & flagItOrPtr ) const

inline

◆ isLiquid() [2/2]

template<typename FlagField_T>

bool walberla::free_surface::FlagInfo< FlagField_T >::isLiquid ( const flag_t val ) const

inline

◆ isObstacle() [1/2]

template<typename FlagField_T>

template<typename FieldItOrPtr_T>

bool walberla::free_surface::FlagInfo< FlagField_T >::isObstacle ( const FieldItOrPtr_T & flagItOrPtr ) const

inline

◆ isObstacle() [2/2]

template<typename FlagField_T>

bool walberla::free_surface::FlagInfo< FlagField_T >::isObstacle ( const flag_t val ) const

inline

◆ isOutflow() [1/2]

template<typename FlagField_T>

template<typename FieldItOrPtr_T>

bool walberla::free_surface::FlagInfo< FlagField_T >::isOutflow ( const FieldItOrPtr_T & flagItOrPtr ) const

inline

◆ isOutflow() [2/2]

template<typename FlagField_T>

bool walberla::free_surface::FlagInfo< FlagField_T >::isOutflow ( const flag_t val ) const

inline

◆ operator!=()

template<typename FlagField_T>

bool walberla::free_surface::FlagInfo< FlagField_T >::operator!= ( const FlagInfo< FlagField_T > & o ) const

◆ operator==()

template<typename FlagField_T>

bool walberla::free_surface::FlagInfo< FlagField_T >::operator== ( const FlagInfo< FlagField_T > & o ) const

◆ registerFlags() [1/2]

template<typename FlagField_T>

void walberla::free_surface::FlagInfo< FlagField_T >::registerFlags ( FlagField_T * field ) const

◆ registerFlags() [2/2]

template<typename FlagField_T>

void walberla::free_surface::FlagInfo< FlagField_T >::registerFlags	(	FlagField_T *	field,
		const Set< field::FlagUID > &	obstacleIDs,
		const Set< field::FlagUID > &	outflowIDs = Set< field::FlagUID >::emptySet(),
		const Set< field::FlagUID > &	inflowIDs = Set< field::FlagUID >::emptySet(),
		const Set< field::FlagUID > &	freeSlipIDs = Set< field::FlagUID >::emptySet() )

static

Member Data Documentation

◆ convertedFlag

template<typename FlagField_T>

flag_t walberla::free_surface::FlagInfo< FlagField_T >::convertedFlag

◆ convertFromGasToInterfaceFlag

template<typename FlagField_T>

flag_t walberla::free_surface::FlagInfo< FlagField_T >::convertFromGasToInterfaceFlag

◆ convertToGasFlag

template<typename FlagField_T>

flag_t walberla::free_surface::FlagInfo< FlagField_T >::convertToGasFlag

◆ convertToInterfaceForInflowFlag

template<typename FlagField_T>

flag_t walberla::free_surface::FlagInfo< FlagField_T >::convertToInterfaceForInflowFlag

◆ convertToLiquidFlag

template<typename FlagField_T>

flag_t walberla::free_surface::FlagInfo< FlagField_T >::convertToLiquidFlag

◆ freeSlipFlagMask

template<typename FlagField_T>

flag_t walberla::free_surface::FlagInfo< FlagField_T >::freeSlipFlagMask

◆ freeSlipIDs_

template<typename FlagField_T>

Set< field::FlagUID > walberla::free_surface::FlagInfo< FlagField_T >::freeSlipIDs_

protected

◆ gasFlag

template<typename FlagField_T>

flag_t walberla::free_surface::FlagInfo< FlagField_T >::gasFlag

◆ inflowFlagMask

template<typename FlagField_T>

flag_t walberla::free_surface::FlagInfo< FlagField_T >::inflowFlagMask

◆ inflowIDs_

template<typename FlagField_T>

Set< field::FlagUID > walberla::free_surface::FlagInfo< FlagField_T >::inflowIDs_

protected

◆ interfaceFlag

template<typename FlagField_T>

flag_t walberla::free_surface::FlagInfo< FlagField_T >::interfaceFlag

◆ keepInterfaceForWettingFlag

template<typename FlagField_T>

flag_t walberla::free_surface::FlagInfo< FlagField_T >::keepInterfaceForWettingFlag

◆ liquidFlag

template<typename FlagField_T>

flag_t walberla::free_surface::FlagInfo< FlagField_T >::liquidFlag

◆ obstacleFlagMask

template<typename FlagField_T>

flag_t walberla::free_surface::FlagInfo< FlagField_T >::obstacleFlagMask

◆ obstacleIDs_

template<typename FlagField_T>

Set< field::FlagUID > walberla::free_surface::FlagInfo< FlagField_T >::obstacleIDs_

protected

◆ outflowFlagMask

template<typename FlagField_T>

flag_t walberla::free_surface::FlagInfo< FlagField_T >::outflowFlagMask

◆ outflowIDs_

template<typename FlagField_T>

Set< field::FlagUID > walberla::free_surface::FlagInfo< FlagField_T >::outflowIDs_

protected

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

/builds/administration/walberla-website/walberla/src/lbm/free_surface/FlagInfo.h
/builds/administration/walberla-website/walberla/src/lbm/free_surface/FlagInfo.impl.h

Public Attributes
flag_t	interfaceFlag
flag_t	liquidFlag
flag_t	gasFlag
flag_t	convertedFlag
flag_t	convertToGasFlag
flag_t	convertToLiquidFlag
flag_t	convertFromGasToInterfaceFlag
flag_t	keepInterfaceForWettingFlag
flag_t	convertToInterfaceForInflowFlag
flag_t	obstacleFlagMask
flag_t	outflowFlagMask
flag_t	inflowFlagMask
flag_t	freeSlipFlagMask

Public Types

Public Member Functions

Static Public Member Functions

Public Attributes

Protected Member Functions

Protected Attributes

Member Typedef Documentation

◆ flag_t

Constructor & Destructor Documentation

◆ FlagInfo() [1/3]

◆ FlagInfo() [2/3]

◆ FlagInfo() [3/3]

Member Function Documentation

◆ getFreeSlipIDs()

◆ getInflowIDs()

◆ getObstacleIDSet()

◆ getOutflowIDs()

◆ hasConverted()

◆ hasConvertedFromGasToInterface() [1/2]

◆ hasConvertedFromGasToInterface() [2/2]

◆ hasConvertedToGas() [1/2]

◆ hasConvertedToGas() [2/2]

◆ hasConvertedToLiquid() [1/2]

◆ hasConvertedToLiquid() [2/2]

◆ isConsistentAcrossBlocksAndProcesses()

◆ isConvertToInterfaceForInflow() [1/2]

◆ isConvertToInterfaceForInflow() [2/2]

◆ isFreeSlip() [1/2]

◆ isFreeSlip() [2/2]

◆ isGas() [1/2]

◆ isGas() [2/2]

◆ isInflow() [1/2]

◆ isInflow() [2/2]

◆ isInterface() [1/2]

◆ isInterface() [2/2]

◆ isKeepInterfaceForWetting() [1/2]

◆ isKeepInterfaceForWetting() [2/2]

◆ isLiquid() [1/2]

◆ isLiquid() [2/2]

◆ isObstacle() [1/2]

◆ isObstacle() [2/2]

◆ isOutflow() [1/2]

◆ isOutflow() [2/2]

◆ operator!=()

◆ operator==()

◆ registerFlags() [1/2]

◆ registerFlags() [2/2]

Member Data Documentation

◆ convertedFlag

◆ convertFromGasToInterfaceFlag

◆ convertToGasFlag

◆ convertToInterfaceForInflowFlag

◆ convertToLiquidFlag

◆ freeSlipFlagMask

◆ freeSlipIDs_

◆ gasFlag

◆ inflowFlagMask

◆ inflowIDs_

◆ interfaceFlag

◆ keepInterfaceForWettingFlag

◆ liquidFlag

◆ obstacleFlagMask

◆ obstacleIDs_

◆ outflowFlagMask

◆ outflowIDs_