Arrange all the domain parameters, run controls and data arrays required for computation. More...

#include <structs.h>

Public Attributes
int	ncores
	Number of CPU threads selected. More...

int	gpuid
	GPU device ID selected by user. More...

double	ti
	Initial time for simulation. More...

double	tf
	Final time for simulation. More...

double	CFL
	CFL restriction for time step limitation. More...

int	writeMass
	Write in output file mass balance information. More...

int	writeExtremes
	Compute and write maximum values for the variables. More...

int	indexWriteHotstart
	Initial output index for the hortstart initialization. More...

int	nIterOut
	Number of iterations for sreen output. More...

double	dtOut
	Temporal frequency for writing state resutls. More...

double	dtDump
	Temporal frequency for dump components integrations. More...

double	minh
	Minimun flow depth for neglecting cell velocity. More...

int	NCwall
	Number of walls per cell :: NCWALL. More...

int	ncells
	Number of cells in the domain :: NCELLS. More...

int	nw_calc
	Number of internal (calculus) walls :: NWCALC. More...

int	nw_bound
	Number of boundary walls. More...

int	nInlet
	Number of inlets in the domain. More...

int	nOutlet
	Number of outlets in the domain. More...

double	t
	Run-control time mark. More...

double	dt
	Run-control time step. More...

int	nIter
	Run-control iteration. More...

int	indexOut
	Run-control state output index. More...

int	indexDump
	Run-control component output index. More...

int	dumpComponent
	Run-control flag to dump components in the current iteration. More...

int	dumpState
	Run-control flag to dump state in the current iteration. More...

double	massOld
	Run-control integrated volume at the beginning of the time step. More...

double	massNew
	Run-control current integrated volume. More...

double	massError
	Run-control mass error computed at the end of the time stop. More...

double	massIn
	Run-control total inflow volume accumulated during the simulation. More...

double	massOut
	Run-control total outflow volume accumulated during the simulation. More...

double	qTotalIn
	Run-control inflow discharge inegrated for all the inlet boundaries. More...

double	qTotalOut
	Run-control outflow discharge inegrated for all the outlet boundaries. More...

int	nSolutes
	Number of solutes. More...

int	nActCells
	Run-control number of active cells. More...

int *	actCells
	[NCELLS] Active cell indexes More...

int *	activeC
	[NCELLS] Local flags for active cells :: [0] Unactive cell - [1] Active cell More...

int *	cidx
	Cell indexes. More...

int *	nneig
	Number of neighboring cells. More...

double *	z
	[NCELLS] Bed elevation in cells More...

double *	h
	[NCELLS] Flow depth in cells More...

double *	hu
	[NCELLS] X-discharge in cells More...

double *	hv
	[NCELLS] Y-discharge in cells More...

double *	u
	[NCELLS] X-velocity in cells More...

double *	v
	[NCELLS] Y-velocity in cells More...

double *	modulou
	[NCELLS] Velocity modulus in cells More...

double *	sqrh
	[NCELLS] Square depth of flow depth in cells More...

double *	area
	[NCELLS] Cell area More...

double *	nman
	[NCELLS] Manning roughness coefficient nMan [s m^(-1/3)] in cells More...

double *	SOX
	[NCELLS] X-direction bed slope More...

double *	SOY
	[NCELLS] Y-direction bed slope More...

double *	mass
	[NCELLS] Mass in cells More...

int	nWallCell

double *	dh
	[NCELLS*NCWALL] Wall-contributions to cell mass More...

double *	dhu
	[NCELLS*NCWALL] Wall-contributions to cell X-momentum More...

double *	dhv
	[NCELLS*NCWALL] Wall-contributions to cell X-momentum More...

int *	solidWallByCell
	[NCELLS*NCWALL] Local flag for solid wall behaviour More...

int *	neighCell
	[NCELLS*NCWALL] Neigboring cell indexes. Boundary neigbour marked with index -1 More...

int *	neighWall
	[NCELLS*NCWALL] Neigboring wall IDs :: Internal calculus wall - Bound walls More...

double *	normalXbyCell
	[NCELLS*NCWALL] X-nomall neighboring wall More...

double *	normalYbyCell
	[NCELLS*NCWALL] Y-nomall neighboring wall More...

int	nActWalls
	Run-control number of active calculus walls. More...

int *	actWalls
	[NWCALC] Active calculus walls indexes More...

int *	activeW
	[NWCALC] Local flags for active calculus walls :: [0] Unactive wall - [1] Active wall More...

int *	widx
	[NWCALC] Calculus walls IDs More...

int *	idx1
	[NWCALC] Neighboring left-cell ID for calculus wall More...

int *	idx2
	[NWCALC] Neigboring right-cell ID for calculus wall More...

int *	idw1
	[NWCALC] Wall-ordering flag in left-cell More...

int *	idw2
	[NWCALC] Wall-ordering flag in right-cell More...

double *	normalX
	[NWCALC] X-normal for calculus wall More...

double *	normalY
	[NWCALC] Y-normal for calculus wall More...

double *	deltaX
	[NWCALC] Distance factor for time step computation More...

double *	length
	[NWCALC] Wall length More...

double *	distNormal
	[NWCALC] Distance between neighboring cell centers projected on the wall-normal direction More...

double *	distCentX
	[NWCALC] Distance between neighboring cell centers projected on the X-direction More...

double *	distCentY
	[NWCALC] Distance between neighboring cell centers projected on the Y-direction More...

double *	nman2wall
	[NWCALC] Square of the averaged Manning parameter at the calculus wall More...

double *	gp
	[NWCALC] Projected gravity acceleration along the bed-normal direction :: gp=g*cos^2(B) More...

int *	typeOfBound
	[NWCALC] Type of bound condition at the wall More...

int *	solidWall
	[NWCALC] Local flag of solid wall behaviour for calculus wall More...

double *	qnormalL
	[NWCALC] Upwind-left volume rate for the calculus wall More...

double *	localDt
	[NWCALC] Local time step limitation for the calculus wall More...

double *	normalXIn

double *	normalYlIn

double *	normalXOut

double *	normalYOut

int	nTotalCellsIn

int *	cidxIn

int *	idBoundIn

double *	lengthwallIn

int	nTotalCellsOut

int *	cidxOut

int *	idBoundOut

double *	lengthwallOut

int	flagDiffusion
	Solute diffusion activation flag. More...

int *	typeDiff

double *	k_xx

double *	k_yy

double *	hcsol
	[NSOL x NCELLS] Solute mass in cells More...

double *	csol
	[NSOL x NCELLS] Solute concentration in cells More...

double *	dhcsol
	[NSOLNCELLSNCWALL] Wall-contributions to cell solute mass More...

Detailed Description

Arrange all the domain parameters, run controls and data arrays required for computation.

Member Data Documentation

◆ actCells

int* t_arrays_::actCells

[NCELLS] Active cell indexes

◆ activeC

int* t_arrays_::activeC

[NCELLS] Local flags for active cells :: [0] Unactive cell - [1] Active cell

◆ activeW

int* t_arrays_::activeW

[NWCALC] Local flags for active calculus walls :: [0] Unactive wall - [1] Active wall

◆ actWalls

int* t_arrays_::actWalls

[NWCALC] Active calculus walls indexes

◆ area

double* t_arrays_::area

[NCELLS] Cell area

◆ CFL

double t_arrays_::CFL

CFL restriction for time step limitation.

◆ cidx

int* t_arrays_::cidx

Cell indexes.

[NCELLS]

◆ cidxIn

int* t_arrays_::cidxIn

◆ cidxOut

int* t_arrays_::cidxOut

◆ csol

double* t_arrays_::csol

[NSOL x NCELLS] Solute concentration in cells

◆ deltaX

double* t_arrays_::deltaX

[NWCALC] Distance factor for time step computation

◆ dh

double* t_arrays_::dh

[NCELLS*NCWALL] Wall-contributions to cell mass

◆ dhcsol

double* t_arrays_::dhcsol

[NSOL*NCELLS*NCWALL] Wall-contributions to cell solute mass

◆ dhu

double* t_arrays_::dhu

[NCELLS*NCWALL] Wall-contributions to cell X-momentum

◆ dhv

double* t_arrays_::dhv

[NCELLS*NCWALL] Wall-contributions to cell X-momentum

◆ distCentX

double* t_arrays_::distCentX

[NWCALC] Distance between neighboring cell centers projected on the X-direction

◆ distCentY

double* t_arrays_::distCentY

[NWCALC] Distance between neighboring cell centers projected on the Y-direction

◆ distNormal

double* t_arrays_::distNormal

[NWCALC] Distance between neighboring cell centers projected on the wall-normal direction

◆ dt

double t_arrays_::dt

Run-control time step.

◆ dtDump

double t_arrays_::dtDump

Temporal frequency for dump components integrations.

◆ dtOut

double t_arrays_::dtOut

Temporal frequency for writing state resutls.

◆ dumpComponent

int t_arrays_::dumpComponent

Run-control flag to dump components in the current iteration.

◆ dumpState

int t_arrays_::dumpState

Run-control flag to dump state in the current iteration.

◆ flagDiffusion

int t_arrays_::flagDiffusion

Solute diffusion activation flag.

◆ gp

double* t_arrays_::gp

[NWCALC] Projected gravity acceleration along the bed-normal direction :: gp=g*cos^2(B)

◆ gpuid

int t_arrays_::gpuid

GPU device ID selected by user.

◆ h

double* t_arrays_::h

[NCELLS] Flow depth in cells

◆ hcsol

double* t_arrays_::hcsol

[NSOL x NCELLS] Solute mass in cells

◆ hu

double* t_arrays_::hu

[NCELLS] X-discharge in cells

◆ hv

double* t_arrays_::hv

[NCELLS] Y-discharge in cells

◆ idBoundIn

int* t_arrays_::idBoundIn

◆ idBoundOut

int* t_arrays_::idBoundOut

◆ idw1

int* t_arrays_::idw1

[NWCALC] Wall-ordering flag in left-cell

◆ idw2

int* t_arrays_::idw2

[NWCALC] Wall-ordering flag in right-cell

◆ idx1

int* t_arrays_::idx1

[NWCALC] Neighboring left-cell ID for calculus wall

◆ idx2

int* t_arrays_::idx2

[NWCALC] Neigboring right-cell ID for calculus wall

◆ indexDump

int t_arrays_::indexDump

Run-control component output index.

◆ indexOut

int t_arrays_::indexOut

Run-control state output index.

◆ indexWriteHotstart

int t_arrays_::indexWriteHotstart

Initial output index for the hortstart initialization.

◆ k_xx

double* t_arrays_::k_xx

◆ k_yy

double * t_arrays_::k_yy

◆ length

double* t_arrays_::length

[NWCALC] Wall length

◆ lengthwallIn

double* t_arrays_::lengthwallIn

◆ lengthwallOut

double* t_arrays_::lengthwallOut

◆ localDt

double* t_arrays_::localDt

[NWCALC] Local time step limitation for the calculus wall

◆ mass

double* t_arrays_::mass

[NCELLS] Mass in cells

◆ massError

double t_arrays_::massError

Run-control mass error computed at the end of the time stop.

◆ massIn

double t_arrays_::massIn

Run-control total inflow volume accumulated during the simulation.

◆ massNew

double t_arrays_::massNew

Run-control current integrated volume.

◆ massOld

double t_arrays_::massOld

Run-control integrated volume at the beginning of the time step.

◆ massOut

double t_arrays_::massOut

Run-control total outflow volume accumulated during the simulation.

◆ minh

double t_arrays_::minh

Minimun flow depth for neglecting cell velocity.

◆ modulou

double* t_arrays_::modulou

[NCELLS] Velocity modulus in cells

◆ nActCells

int t_arrays_::nActCells

Run-control number of active cells.

◆ nActWalls

int t_arrays_::nActWalls

Run-control number of active calculus walls.

◆ ncells

int t_arrays_::ncells

Number of cells in the domain :: NCELLS.

◆ ncores

int t_arrays_::ncores

Number of CPU threads selected.

◆ NCwall

int t_arrays_::NCwall

Number of walls per cell :: NCWALL.

◆ neighCell

int* t_arrays_::neighCell

[NCELLS*NCWALL] Neigboring cell indexes. Boundary neigbour marked with index -1

◆ neighWall

int* t_arrays_::neighWall

[NCELLS*NCWALL] Neigboring wall IDs :: Internal calculus wall - Bound walls

◆ nInlet

int t_arrays_::nInlet

Number of inlets in the domain.

◆ nIter

int t_arrays_::nIter

Run-control iteration.

◆ nIterOut

int t_arrays_::nIterOut

Number of iterations for sreen output.

◆ nman

double* t_arrays_::nman

[NCELLS] Manning roughness coefficient nMan [s m^(-1/3)] in cells

◆ nman2wall

double* t_arrays_::nman2wall

[NWCALC] Square of the averaged Manning parameter at the calculus wall

◆ nneig

int* t_arrays_::nneig

Number of neighboring cells.

[NCELLS]

◆ normalX

double* t_arrays_::normalX

[NWCALC] X-normal for calculus wall

◆ normalXbyCell

double* t_arrays_::normalXbyCell

[NCELLS*NCWALL] X-nomall neighboring wall

◆ normalXIn

double* t_arrays_::normalXIn

◆ normalXOut

double* t_arrays_::normalXOut

◆ normalY

double* t_arrays_::normalY

[NWCALC] Y-normal for calculus wall

◆ normalYbyCell

double* t_arrays_::normalYbyCell

[NCELLS*NCWALL] Y-nomall neighboring wall

◆ normalYlIn

double * t_arrays_::normalYlIn

◆ normalYOut

double * t_arrays_::normalYOut

◆ nOutlet

int t_arrays_::nOutlet

Number of outlets in the domain.

◆ nSolutes

int t_arrays_::nSolutes

Number of solutes.

◆ nTotalCellsIn

int t_arrays_::nTotalCellsIn

◆ nTotalCellsOut

int t_arrays_::nTotalCellsOut

◆ nw_bound

int t_arrays_::nw_bound

Number of boundary walls.

◆ nw_calc

int t_arrays_::nw_calc

Number of internal (calculus) walls :: NWCALC.

◆ nWallCell

int t_arrays_::nWallCell

◆ qnormalL

double* t_arrays_::qnormalL

[NWCALC] Upwind-left volume rate for the calculus wall

◆ qTotalIn

double t_arrays_::qTotalIn

Run-control inflow discharge inegrated for all the inlet boundaries.

◆ qTotalOut

double t_arrays_::qTotalOut

Run-control outflow discharge inegrated for all the outlet boundaries.

◆ solidWall

int* t_arrays_::solidWall

[NWCALC] Local flag of solid wall behaviour for calculus wall

◆ solidWallByCell

int* t_arrays_::solidWallByCell

[NCELLS*NCWALL] Local flag for solid wall behaviour

◆ SOX

double* t_arrays_::SOX

[NCELLS] X-direction bed slope

◆ SOY

double* t_arrays_::SOY

[NCELLS] Y-direction bed slope

◆ sqrh

double* t_arrays_::sqrh

[NCELLS] Square depth of flow depth in cells

◆ t

double t_arrays_::t

Run-control time mark.

◆ tf

double t_arrays_::tf

Final time for simulation.

◆ ti

double t_arrays_::ti

Initial time for simulation.

◆ typeDiff

int* t_arrays_::typeDiff

◆ typeOfBound

int* t_arrays_::typeOfBound

[NWCALC] Type of bound condition at the wall

◆ u

double* t_arrays_::u

[NCELLS] X-velocity in cells

◆ v

double* t_arrays_::v

[NCELLS] Y-velocity in cells

◆ widx

int* t_arrays_::widx

[NWCALC] Calculus walls IDs

◆ writeExtremes

int t_arrays_::writeExtremes

Compute and write maximum values for the variables.

◆ writeMass

int t_arrays_::writeMass

Write in output file mass balance information.

◆ z

double* t_arrays_::z

[NCELLS] Bed elevation in cells

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

src/structs.h

Public Attributes