#include <eddy.h>

Public Member Functions
void	sampleEddySize ()

void	sampleEddyPosition ()

void	tripMap (domain *line, const int iS, int iE, const double C, const bool LsplitAtEddy=false)

bool	eddyTau (const double Z_value, const double C)

void	computeEddyAcceptanceProb (const double dtSample)

void	applyVelocityKernels (domain *line, const int iS, const int iE)

	eddy ()

void	init (domain p_domn, domain p_eddl)

	~eddy ()

Public Attributes
domain *	domn
	pointer to domain object

domain *	eddl
	pointer to eddy line object

double	eddySize
	size of eddy

double	leftEdge
	left edge location of eddy

double	rightEdge
	right edge location of eddy

double	invTauEddy
	inverse eddy timescale

double	Pa
	eddy acceptance probability

bool	LperiodicEddy
	a wrap-around eddy

vector< double >	cCoef
	coefficient of K kernel

vector< double >	bCoef
	coefficient of J kernel

vector< double >	K
	eddy kernel K

vector< double >	dxc
	\delta(x^cCoord) is prop. to cell "volume"

vector< double >	pos0
	initial eddy cell locations, for kernel

double	esdp1
	eddy size distribution parameters.

double	esdp2

double	esdp3

double	esdp4

vector< double >	cca

vector< double >	ccb

vector< double >	ccc

vector< double >	ccd
	polynomial coefficient arrays for cylindricalAnomalyHack

Private Member Functions
void	fillKernel ()

void	fillKernel_planarAnalytic ()

double	eddyFavreAvgVelocity (const vector< double > &dxc)

void	set_kernel_coefficients ()

Detailed Description

Class implementing eddy object

Author: David O. Lignell

Definition at line 21 of file eddy.h.

Constructor & Destructor Documentation

◆ eddy()

eddy::eddy ( )

inline

Definition at line 69 of file eddy.h.

◆ ~eddy()

eddy::~eddy ( )

inline

Definition at line 71 of file eddy.h.

Member Function Documentation

◆ applyVelocityKernels()

void eddy::applyVelocityKernels	(	domain *	line,
		const int	iS,
		const int	iE )

Apply kernels K and J to the velocity profile. This is called after the kernel coefficients is computed in eddyTau

Definition at line 551 of file eddy.cc.

◆ computeEddyAcceptanceProb()

void eddy::computeEddyAcceptanceProb ( const double dtSample )

Eddy acceptance probability is computed after several previous steps.

Parameters

dtSample input: eddy sample time step.

Definition at line 528 of file eddy.cc.

◆ eddyFavreAvgVelocity()

double eddy::eddyFavreAvgVelocity ( const vector< double > & dxc )

private

Get the Favre average streamwise velocity for spatial formulations. Used to convert from eddy timescale to the eddy spatial scale.

Parameters

dxc	input: cell volumes

Returns: value of the favre avg velocity

Definition at line 652 of file eddy.cc.

◆ eddyTau()

bool eddy::eddyTau	(	const double	Z_value,
		const double	C )

Compute the inverse of the eddy timescale. Used to define the eddy acceptance probability.

Parameters

Z_value input: large eddy suppression parameter.

Returns: false for implausible eddy, true for the usual, proper eddy.

Definition at line 285 of file eddy.cc.

◆ fillKernel()

void eddy::fillKernel ( )

private

Fill velocity kernel K (used also for ) this defines the kernel in terms of eddy displacements

Definition at line 618 of file eddy.cc.

◆ fillKernel_planarAnalytic()

void eddy::fillKernel_planarAnalytic ( )

private

Fill velocity kernel K (used also for ) this applies the planar analytic definition

Definition at line 590 of file eddy.cc.

◆ init()

void eddy::init	(	domain *	p_domn,
		domain *	p_eddl )

eddy initialization function

Parameters

p_domn	input: set domain pointer with.
p_eddl	input: set domain pointer with.

Definition at line 19 of file eddy.cc.

◆ sampleEddyPosition()

void eddy::sampleEddyPosition ( )

Uniformly sample the eddy position on the domain. For periodic domains the position can be anywhere. For nonperiodic domains, the position is from 0 to the end where end is the domain size - the eddy size (since the eddy has to fit in the domain). This also means that the eddy position is the left edge of the eddy. For periodic domains, rightEdge is greater than leftEdge (even for eddies that wrap the domain, and may be outside the range of the base domain.)

Definition at line 86 of file eddy.cc.

◆ sampleEddySize()

void eddy::sampleEddySize ( )

Sample an eddy size from the eddy size distribution. This could be as simple as a tophat, but this function is more accurate, and more efficient.

Definition at line 71 of file eddy.cc.

◆ set_kernel_coefficients()

void eddy::set_kernel_coefficients ( )

private

Compute the kernel coefficients. This used to be done in eddyTau, but to allow more flexibility, especially for cylindrical and spherical cases it is split off. Namely, for cylindrical and spherical, we evaluate a "planar" eddyTau so that a constant shear will give a uniform eddyTau with respect to position. But we need to evaluate the kernel coefficients using cylindrical or spherical so that we are conservative of momentum and energy.

Definition at line 430 of file eddy.cc.

◆ tripMap()

void eddy::tripMap	(	domain *	line,
		const int	iS,
		int	iE,
		const double	C,
		const bool	LsplitAtEddy = false )

Triplet map the domain This version will adjust the TM so that the three segments are spaced evenly in cylindrical and spherical flows. (planar = no difference). This can be converted back to the usual equal volume segments by making fracVleft = 1/3 etc.

Parameters

line	input/output: either the domn or the eddl
iS	input: starting cell
iE	input: ending cell (Note, this could be done by the lv objects separately.) Applies to an eddy line, or the full odt line.

Definition at line 116 of file eddy.cc.

Member Data Documentation

◆ bCoef

vector<double> eddy::bCoef

coefficient of J kernel

Definition at line 37 of file eddy.h.

◆ cca

vector<double> eddy::cca

Definition at line 47 of file eddy.h.

◆ ccb

vector<double> eddy::ccb

Definition at line 47 of file eddy.h.

◆ ccc

vector<double> eddy::ccc

Definition at line 47 of file eddy.h.

◆ ccd

vector<double> eddy::ccd

polynomial coefficient arrays for cylindricalAnomalyHack

Definition at line 47 of file eddy.h.

◆ cCoef

vector<double> eddy::cCoef

coefficient of K kernel

Definition at line 36 of file eddy.h.

◆ domn

domain* eddy::domn

pointer to domain object

Definition at line 27 of file eddy.h.

◆ dxc

vector<double> eddy::dxc

\delta(x^cCoord) is prop. to cell "volume"

Definition at line 39 of file eddy.h.

◆ eddl

domain* eddy::eddl

pointer to eddy line object

Definition at line 28 of file eddy.h.

◆ eddySize

double eddy::eddySize

size of eddy

Definition at line 30 of file eddy.h.

◆ esdp1

double eddy::esdp1

eddy size distribution parameters.

Definition at line 42 of file eddy.h.

◆ esdp2

double eddy::esdp2

Definition at line 43 of file eddy.h.

◆ esdp3

double eddy::esdp3

Definition at line 44 of file eddy.h.

◆ esdp4

double eddy::esdp4

Definition at line 45 of file eddy.h.

◆ invTauEddy

double eddy::invTauEddy

inverse eddy timescale

Definition at line 33 of file eddy.h.

◆ K

vector<double> eddy::K

eddy kernel K

Definition at line 38 of file eddy.h.

◆ leftEdge

double eddy::leftEdge

left edge location of eddy

Definition at line 31 of file eddy.h.

◆ LperiodicEddy

bool eddy::LperiodicEddy

a wrap-around eddy

Definition at line 35 of file eddy.h.

◆ Pa

double eddy::Pa

eddy acceptance probability

Definition at line 34 of file eddy.h.

◆ pos0

vector<double> eddy::pos0

initial eddy cell locations, for kernel

Definition at line 40 of file eddy.h.

◆ rightEdge

double eddy::rightEdge

right edge location of eddy

Definition at line 32 of file eddy.h.

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

Public Member Functions

Public Attributes

Private Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ eddy()

◆ ~eddy()

Member Function Documentation

◆ applyVelocityKernels()

◆ computeEddyAcceptanceProb()

◆ eddyFavreAvgVelocity()

◆ eddyTau()

◆ fillKernel()

◆ fillKernel_planarAnalytic()

◆ init()

◆ sampleEddyPosition()

◆ sampleEddySize()

◆ set_kernel_coefficients()

◆ tripMap()

Member Data Documentation

◆ bCoef

◆ cca

◆ ccb

◆ ccc

◆ ccd

◆ cCoef

◆ domn

◆ dxc

◆ eddl

◆ eddySize

◆ esdp1

◆ esdp2

◆ esdp3

◆ esdp4

◆ invTauEddy

◆ K

◆ leftEdge

◆ LperiodicEddy

◆ Pa

◆ pos0

◆ rightEdge