BorderBoundary

class fastscape.processes.BorderBoundary(*, status='fixed_value')

Sets boundary conditions at grid borders.

Borders are defined in the following order:

left, right, top, bottom

Border status can be one of:

“core” (open boundary)
“fixed_value” (closed boundary)
“looped” (periodic boundary)

“fixed_value” must be set for at least one border. This is the minimal constraint in order to make the numerical model solvable.

“looped” must be symmetric, i.e., defined for (left, right) or (top, bottom).

Note that currently if “core” is set for two opposed borders these will have periodic conditions (this comes from a current limitation in fastscapelib-fortran which will be solved in a next release).

status

Node status at borders

Variable properties:

type : variable
intent : in
dimensions : () or (‘border’,)
default value : fixed_value
static : True

Type:: attr.Attribute

border

4-border boundaries coordinate

Variable properties:

type : index
intent : out
dimensions : (‘border’,)

Type:: attr.Attribute

border_status

Node status at the 4-border boundaries

Variable properties:

type : variable
intent : out
dimensions : (‘border’,)

Type:: attr.Attribute

ibc

Boundary code used by fastscapelib-fortran

Variable properties:

type : variable
intent : out
dimensions : ()

Type:: attr.Attribute

Methods

`__init__`(*[, status])	Method generated by attrs for class BorderBoundary.
`initialize`()

Output of process info:

In [1]: import xsimlab as xs

In [2]: from fastscape.processes import BorderBoundary

In [3]: xs.process_info(BorderBoundary)
<BorderBoundary  (xsimlab process)>
Variables:
    status            [in] () or ('border',) node status at borders
    border           [out] ('border',) 4-border boundaries coordinate
    border_status    [out] ('border',) node status at the 4-border ...
    ibc              [out] boundary code used by fastscapelib-fortran
Simulation stages:
    initialize