cli: Boundary (*.cli) object

In telemac: R Interface to the TELEMAC Model Suite

Description

Initialise a boundary (*.cli) object for use within TELEMAC.

Usage

cli(x, fname, ...)

## S3 method for class 'character'
cli(x, fname = NULL, ...)

## S3 method for class 'numeric'
cli(x, fname = NULL, ...)

## S3 method for class 't2d_geo'
cli(x, fname = NULL, ...)

## S3 method for class 'data.frame'
cli(x, fname = NULL, ...)

## S3 method for class 't2d_cli'
cli(x, fname = NULL, df = NULL, ...)

## S3 method for class 't2d_cli'
print(x, ..., n = 10)

## S3 method for class 't2d_cli'
x[...]

Arguments

x	Either: A character string providing the name of an existing boundary file; a numeric vector of ipobo values (see geo) resulting in template boundary values (closed boundary with zero prescribed depths / velocities); an object of class t2d_geo providing ipobo values converted into template boundary values; a data.frame with required columns (see 'Value') giving the boundary parameters; an object of class t2d_cli.
fname	character string providing the name of the boundary file that is to be generated (can also be used to replace an existing entry).
...	Arguments passed to or from other methods.
df	data.frame that can be given to update an existing object x.
n	Maximum number of boundary points to print.

Value

An object of class t2d_cli consisting of an attribute file pointing to a specific boundary file and a data.frame where each row represents a point along the mesh boundary. Columns refer to:

lihbor

Depth conditions

liubor

Velocity conditions in u direction

livbor

Velocity conditions in v direction

hbor

Prescribed depth if lihbor = 5

ubor

Prescribed velocity if liubor = 6

vbor

Prescribed velocity if livbor = 6

aubor

Friction coefficient at boundary if liubor or livbor = 2

litbor

Tracer conditions

tbor

Prescribed value of tracer if litbor = 5

atbor

Coefficient of flow relation

btbor

Coefficient of flow relation

n

Global number of boundary point

k

Point number of boundary point numbering; can also represent a node colour

See TELEMAC-2D user manual for more information.

telemac documentation built on Feb. 7, 2022, 5:06 p.m.