floris.core.core

floris.core.core#

Functions

check_input_file_for_v3_keys(input_dict)

Checks if any FLORIS v3 keys are present in the input file and raises special errors if the extra keys belong to a v3 definition of the input_dct.

Classes

Core(logging, solver, wake, farm, ...)

Top-level class that describes a Floris model and initializes the simulation.
class floris.core.core.Core(logging, solver, wake, farm, flow_field, name, description, floris_version)[source]#

Top-level class that describes a Floris model and initializes the simulation. Use the Farm attribute to access other objects within the model.

Parameters:

  • logging (dict)

  • solver (dict)

  • wake (dict)

  • farm (dict)

  • flow_field (dict)

  • name (str)

  • description (str)

  • floris_version (str)

logging: dict#
solver: dict#
wake: WakeModelManager#
farm: Farm#
flow_field: FlowField#
name: str#
description: str#
floris_version: str#
grid: Grid#
initialize_domain()[source]#

Initialize solution space prior to wake calculations

steady_state_atmospheric_condition()[source]#

Perform the steady-state wind farm wake calculations. Note that initialize_domain() is required to be called before this function.

solve_for_viz()[source]#
solve_for_points(x, y, z)[source]#
solve_for_velocity_deficit_profiles(direction, downstream_dists, profile_range, resolution, homogeneous_wind_speed, ref_rotor_diameter, x_start, y_start, reference_height)[source]#

Extract velocity deficit profiles. See sample_velocity_deficit_profiles() for more details.

Return type:

list[DataFrame]

Parameters:

  • direction (str)

  • downstream_dists (ndarray[Any, dtype[float64]] | list)

  • profile_range (ndarray[Any, dtype[float64]] | list)

  • resolution (int)

  • homogeneous_wind_speed (float)

  • ref_rotor_diameter (float)

  • x_start (float)

  • y_start (float)

  • reference_height (float)

finalize()[source]#
classmethod from_file(input_file_path)[source]#

Creates a Floris instance from an input file. Must be filetype YAML.

Return type:

Core

Parameters:

input_file_path (str | Path)

Args:
input_file_path (str): The relative or absolute file path and name to the

input file.

Returns:

Floris: The class object instance.

to_file(output_file_path)[source]#

Converts the Floris object to an input-ready YAML file at output_file_path.

Return type:

None

Parameters:

output_file_path (str)

Args:

output_file_path (str): The full path and filename for where to save the file.

floris.core.core.check_input_file_for_v3_keys(input_dict)[source]#

Checks if any FLORIS v3 keys are present in the input file and raises special errors if the extra keys belong to a v3 definition of the input_dct. and raises special errors if the extra arguments belong to a v3 definition of the class.

Return type:

None

Args:

input_dict (dict): The input dictionary to be checked for v3 keys.