pymt.services.constant package

Submodules

pymt.services.constant.constant module

class pymt.services.constant.constant.ConstantScalars

Bases: object

Service component that returns scalars.

finalize()

Clean up.

get_current_time()

Component current time.

get_end_time()

Component stop time.

get_grid_origin(grid_id)

Origin of grid.

Parameters:

grid_id (int) – Grid identifier.

Returns:

origin – Origin of nodes in each dimension.

Return type:

tuple

get_grid_shape(grid_id)

Shape of grid.

Parameters:

grid_id (int) – Grid identifier.

Returns:

shape – Shape of the grid.

Return type:

tuple

get_grid_spacing(grid_id)

Spacing of grid.

Parameters:

grid_id (int) – Grid identifier.

Returns:

spacing – Spacing of nodes in each dimension.

Return type:

tuple

get_input_var_names()

Input variable names.

get_output_var_names()

Output variable names.

get_start_time()

Component start time.

get_value(name)

Values on nodes of a grid.

Parameters:

var (str) – Name of grid variable.

Returns:

values – Values of the nodes of a grid.

Return type:

ndarray

get_var_grid(var)

Grid identifier for a variable.

Parameters:

var (str) – Name of grid variable.

Returns:

Grid identifier.

Return type:

int

initialize(filename)

Initialize the component from a file.

Parameters:

filename (str) – Name of initialization file.

update(time)

Update one time step.

update_until(time)

Update until a time.

class pymt.services.constant.constant.River

Bases: ConstantScalars

pymt.services.constant.river module

class pymt.services.constant.river.River

Bases: ConstantScalars

Module contents