FlowPatternAscii< NX, NY > Class Template Reference

#include <FlowPattern.h>

Inheritance diagram for FlowPatternAscii< NX, NY >:

Public Member Functions
	FlowPatternAscii (const std::array< std::string, NY > &pattern)
int	countIn (void) const override
	return the number of inlets More...
int	countOut (void) const override
	return the number of outlets More...
Libpf::Utility::Direction	operator() (int i, int j) const override
	returns the Direction of the outgoing flowpath from cell i, j More...
bool	in (int i, int j) const override
	returns true if the inlet of cell i, j is connected to source, i.e. if the cell is the beginning of a flowpath More...
bool	out (int i, int j) const override
	returns true if the outlet of cell i, j is connected to sink, i.e. if the cell is the end of a flowpath More...
Public Member Functions inherited from FlowPattern
	FlowPattern (int Nx, int Ny)
virtual	~FlowPattern (void)
void	print (void) const
	print to std::cout a complete description of the flow pattern More...
int	Xtranslated (int i, int j) const
	returns the X coordinate translated according to the Direction of cell i, j More...
int	Ytranslated (int i, int j) const
	returns the Y coordinate translated according to the Direction of cell i, j More...
virtual int	countIn (void) const =0
	return the number of inlets More...
virtual int	countOut (void) const =0
	return the number of outlets More...
virtual Libpf::Utility::Direction	operator() (int i, int j) const =0
	returns the Direction of the outgoing flowpath from cell i, j More...
virtual bool	in (int i, int j) const =0
	returns true if the inlet of cell i, j is connected to source, i.e. if the cell is the beginning of a flowpath More...
virtual bool	out (int i, int j) const =0
	returns true if the outlet of cell i, j is connected to sink, i.e. if the cell is the end of a flowpath More...

Additional Inherited Members
Protected Member Functions inherited from FlowPattern
int	translateX_ (Libpf::Utility::Direction d, int i) const
	returns the X coordinate translated according to Direction d More...
int	translateY_ (Libpf::Utility::Direction d, int j) const
	returns the Y coordinate translated according to Direction d More...
Protected Attributes inherited from FlowPattern
int	Nx_
	number of cells in horizontal Direction More...
int	Ny_

Detailed Description

template<int NX, int NY>
class FlowPatternAscii< NX, NY >

Flow pattern defined with help of an array of strings
Templated for the number of cells:

• Nx Number of cells in horizontal direction
• Ny Number of cells in vertical direction

#include <libpf/core/FlowPattern.h>

Remarks

Warning

Thread safe:

Extendable:

Platform dependencies:

Constructor & Destructor Documentation

FlowPatternAscii()

template<int NX, int NY>

FlowPatternAscii< NX, NY >::FlowPatternAscii

(

const std::array< std::string, NY > &

pattern

)

Member Function Documentation

countIn()

template<int NX, int NY>

int FlowPatternAscii< NX, NY >::countIn ( void  ) const

overridevirtual

return the number of inlets

Implements FlowPattern.

countOut()

template<int NX, int NY>

int FlowPatternAscii< NX, NY >::countOut ( void  ) const

overridevirtual

return the number of outlets

Implements FlowPattern.

in()

template<int NX, int NY>

bool FlowPatternAscii< NX, NY >::in ( int  i, int  j  ) const

overridevirtual

returns true if the inlet of cell i, j is connected to source, i.e. if the cell is the beginning of a flowpath

Implements FlowPattern.

operator()()

template<int NX, int NY>

Libpf::Utility::Direction FlowPatternAscii< NX, NY >::operator() ( int  i, int  j  ) const

overridevirtual

returns the Direction of the outgoing flowpath from cell i, j

Implements FlowPattern.

out()

template<int NX, int NY>

bool FlowPatternAscii< NX, NY >::out ( int  i, int  j  ) const

overridevirtual

returns true if the outlet of cell i, j is connected to sink, i.e. if the cell is the end of a flowpath

Implements FlowPattern.

---

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

• FlowPattern.h