Representation of a brine channel. More...

#include <Channel.h>

Inheritance diagram for Channel:

Public Member Functions
	Channel ()
	Standard creator.

	Channel (const IntVect &iv)
	Create with intvectset.

bool	borders (const IntVect &iv)
	Does this channel border the intvect?

Real	width (Side::LoHiSide a_side, int a_offset, Real a_dx)
	Get the width at the vertical position specified.

Real	height (Real a_dx)
	Channel height.

Real	averageWidth (Real a_dx)
	Chanel width, averaged over height.

Real	location ()
	Horizontal position in grid. More...

void	removeBottomCells ()
	Remove bottom row of cells.

bool	isFinished ()
	Have we finished defining a channel.

void	setFinished ()
	Set isFinished to true.

virtual	~Channel ()
	Destructor.

Public Member Functions inherited from IntVectSet
bool	operator== (const IntVectSet &a_ivs) const

bool	operator< (const IntVectSet &a_ivs) const

void	printBoxes (std::ostream &a_ostream) const

void	p () const

void	convert () const

void	define ()

	IntVectSet (const IntVectSet &ivs)

void	define (const IntVectSet &ivs)

void	define_intvectset (const IntVectSet &ivs)

IntVectSet	copy () const

	IntVectSet (const DenseIntVectSet &a_dense)

void	define (const DenseIntVectSet &a_dense)

	IntVectSet (const TreeIntVectSet &a_tree)

void	define (const TreeIntVectSet &a_tree)

	IntVectSet (const IntVect &iv)

void	define (const IntVect &iv)

void	define_intvect (const IntVect &iv)

	IntVectSet (const Box &b)

void	define (const Box &b)

void	define_box (const Box &b)

void	define_boxCorners (const Box &b)

IntVectSet &	operator\|= (const IntVectSet &ivs)

void	or_intvectset (const IntVectSet &ivs)

IntVectSet &	operator\|= (const IntVect &iv)

void	or_intvect (const IntVect &ivs)

IntVectSet &	operator\|= (const Box &b)

void	or_box (const Box &b)

IntVectSet	operator- (const IntVectSet &ivs) const

IntVectSet	operator- (const Box &b) const

IntVectSet	operator- (const IntVect &iv) const

IntVectSet &	operator-= (const IntVectSet &ivs)

void	minus (const IntVectSet &ivs)

IntVectSet &	operator-= (const Box &b)

void	minus_box (const Box &b)

IntVectSet &	operator-= (const IntVect &iv)

void	minus_intvect (const IntVect &iv)

IntVectSet &	operator &= (const IntVectSet &ivs)

void	and_intvectset (const IntVectSet &ivs)

IntVectSet &	operator &= (const Box &b)

void	and_box (const Box &b)

IntVectSet &	operator &= (const ProblemDomain &domain)

void	and_domain (const ProblemDomain &d)

void	grow (int igrow)

IntVectSet &	grow (int idir, int igrow)

void	grow_dir (int idir, int igrow)

void	growHi ()

void	growHi (const int a_dir)

IntVectSet &	refine (int iref=2)

IntVectSet &	coarsen (int iref=2)

void	shift (const IntVect &iv)

void	nestingRegion (int radius, const Box &domain, int granularity=1)

void	nestingRegion (int radius, const ProblemDomain &probdomain, int granularity=1)

void	nestingRegion_prob (int radius, const ProblemDomain &probdomain)

void	makeEmpty ()

void	makeEmptyBits ()

IntVectSet	chop (int dir, int chop_pnt)

void	chop (int dir, int chop_pnt, IntVectSet &a_hi)

int	numPts () const

const Box &	minBox () const

void	recalcMinBox () const

bool	isEmpty () const

bool	isDense () const

bool	contains (const IntVect &iv) const

bool	contains (const IntVectSet &ivs) const

bool	contains_intvectset (const IntVectSet &ivs) const

bool	contains (const Box &box) const

bool	contains_box (const Box &b) const

Vector< Box >	boxes () const

void	compact () const

int	linearSize () const

void	linearIn (const void *const a_inBuf)

void	linearOut (void *const a_outBuf) const

Static Public Member Functions
static void	channelSpacing (Vector< Real > &a_spacing, Vector< Channel *> &a_channels, Real a_dx, ProblemDomain a_probDomain)
	Compute channel spacing.

Static Public Member Functions inherited from IntVectSet
static void	setMaxDense (const int &a_maxDense)

Additional Inherited Members
Static Public Attributes inherited from IntVectSet
static long int	count

static long int	peakcount

static int	s_maxDense

Detailed Description

Representation of a brine channel.

Consider a channel as just a collection of IntVects (an IntVectSet) but with a few other helpful functions e.g. calculating the width

Member Function Documentation

◆ location()

Real Channel::location ( )

Horizontal position in grid.

Implicit assumption here is all channels are symmetric

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

/home/parkinsonjl/mushy-layer/src/Channel.h
/home/parkinsonjl/mushy-layer/src/Channel.cpp

Public Member Functions

Static Public Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ location()