FlowPattern Class Reference

#include <FlowPattern.h>

Inheritance diagram for FlowPattern:

Public Member Functions
	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...

Protected Member Functions
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
int	Nx_
	number of cells in horizontal Direction More...
int	Ny_

Detailed Description

Abstract class, contains operations that every derived class must implement Describes the flow pattern in a 2D plane discretized in cells assumes each flowpath is ultimately connected to a source and a sink they can not intersect, split ...

#include <libpf/core/FlowPattern.h>

Remarks

Warning

Thread safe:

Extendable:

Platform dependencies:

Constructor & Destructor Documentation

FlowPattern()

FlowPattern::FlowPattern ( int  Nx, int  Ny  )

inline

Constructor

Parameters

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

~FlowPattern()

virtual FlowPattern::~FlowPattern ( void  )

inlinevirtual

Member Function Documentation

countIn()

virtual int FlowPattern::countIn ( void  ) const

pure virtual

return the number of inlets

Implemented in FlowPatternAscii< NX, NY >, FlowPatternAscii< 6, 6 >, FlowPatternAscii< 9, 6 >, FlowPatternDummy, and FlowPatternSimple< NX, NY >.

countOut()

virtual int FlowPattern::countOut ( void  ) const

pure virtual

return the number of outlets

Implemented in FlowPatternAscii< NX, NY >, FlowPatternAscii< 6, 6 >, FlowPatternAscii< 9, 6 >, FlowPatternDummy, and FlowPatternSimple< NX, NY >.

in()

virtual bool FlowPattern::in ( int  i, int  j  ) const

pure virtual

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

Implemented in FlowPatternAscii< NX, NY >, FlowPatternAscii< 6, 6 >, FlowPatternAscii< 9, 6 >, FlowPatternSimple< NX, NY >, and FlowPatternDummy.

operator()()

virtual Libpf::Utility::Direction FlowPattern::operator() ( int  i, int  j  ) const

pure virtual

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

Implemented in FlowPatternAscii< NX, NY >, FlowPatternAscii< 6, 6 >, FlowPatternAscii< 9, 6 >, FlowPatternSimple< NX, NY >, and FlowPatternDummy.

out()

virtual bool FlowPattern::out ( int  i, int  j  ) const

pure virtual

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

Implemented in FlowPatternAscii< NX, NY >, FlowPatternAscii< 6, 6 >, FlowPatternAscii< 9, 6 >, FlowPatternSimple< NX, NY >, and FlowPatternDummy.

print()

void FlowPattern::print

(

void

)

const

print to std::cout a complete description of the flow pattern

translateX_()

int FlowPattern::translateX_ ( Libpf::Utility::Direction  d, int  i  ) const

protected

returns the X coordinate translated according to Direction d

translateY_()

int FlowPattern::translateY_ ( Libpf::Utility::Direction  d, int  j  ) const

protected

returns the Y coordinate translated according to Direction d

Xtranslated()

int FlowPattern::Xtranslated	(	int	i,
		int	j
	)		const

returns the X coordinate translated according to the Direction of cell i, j

Ytranslated()

int FlowPattern::Ytranslated	(	int	i,
		int	j
	)		const

returns the Y coordinate translated according to the Direction of cell i, j

Member Data Documentation

Nx_

int FlowPattern::Nx_

protected

number of cells in horizontal Direction

Ny_

int FlowPattern::Ny_

protected

number of cells in vertical Direction

---

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

• FlowPattern.h