Class BmiClass

constructor

• new BmiClass(): BmiClass

• Returns BmiClass

config

model

get_component_name

• get_component_name(): string

• Returns string

get_current_time

• get_current_time(): number

• Returns number

get_end_time

• get_end_time(): number

• Returns number

get_grid_type

• get_grid_type(): string

• Returns string

get_output_item_count

• get_output_item_count(): number

• Returns number

get_output_var_names

• get_output_var_names(): string[]

• Returns string[]

get_time_step

• get_time_step(): number

• Returns number

get_time_units

• get_time_units(): string

• Returns string

get_value

• get_value(name): [number]

• Parameters

  • name: string

  Returns [number]

get_var_grid

• get_var_grid(name): number

• Parameters

  • name: string

  Returns number

get_var_location

• get_var_location(name): string

• Parameters

  • name: string

  Returns string

get_var_type

• get_var_type(name): string

• Parameters

  • name: string

  Returns string

initialize

• initialize(config): void

• Parameters

  • config: Config

  Returns void

run

• run<T>(options): {
      t: number[];
  } & {
      [K in string]: number[]
  }

• Runs the model till the end and returns the output data.

  Type Parameters

  • T extends string[]

  Parameters

  • options: {
        freq?: number;
        var_names?: T;
    }

    The options for running the model.

    • Optionalfreq?: number

      The frequency at which to record the output data. Default is 60 seconds.

    • Optionalvar_names?: T

      For which output variables to record the data. Default is all output variables.

  Returns {
      t: number[];
  } & {
      [K in string]: number[]
  }

  The output data, including the time values in t key and the values of the output variables.

update

• update(): void

• Returns void