foxes.core¶

Contains core functionality and abstract base classes.

class foxes.core.Data(foxes.utils.Dict)[source]

Container for numpy array data and the associated meta data.

class foxes.core.MData(foxes.core.Data)[source]

Container for foxes model data.

class foxes.core.FData(foxes.core.Data)[source]

Container for foxes farm data.

class foxes.core.TData(foxes.core.Data)[source]

Container for foxes target data.

class foxes.core.Model(abc.ABC)[source]

Base class for all models.

class foxes.core.DataCalcModel(foxes.core.Model)[source]

Abstract base class for models that run calculation on xarray Dataset data.

class foxes.core.Engine(abc.ABC)[source]

Abstract base clas for foxes calculation engines

foxes.core.get_engine(error=True, default=True)[source]

Gets the global calculation engine

foxes.core.has_engine()[source]

Flag that checks if engine has been set

foxes.core.reset_engine()[source]

Resets the global calculation engine

class foxes.core.States(foxes.core.PointDataModel)[source]

Abstract base class for states.

class foxes.core.ExtendedStates(foxes.core.States)[source]

States extended by point data models.

class foxes.core.WindFarm[source]

The wind farm.

class foxes.core.Algorithm(foxes.core.Model)[source]

Abstract base class for algorithms.

class foxes.core.FarmDataModel(foxes.core.DataCalcModel)[source]

Abstract base class for models that modify farm data.

class foxes.core.FarmDataModelList(foxes.core.FarmDataModel)[source]

A list of farm data models.

class foxes.core.PointDataModel(foxes.core.DataCalcModel)[source]

Abstract base class for models that modify point based data.

class foxes.core.PointDataModelList(foxes.core.PointDataModel)[source]

A list of point data models.

class foxes.core.RotorModel(foxes.core.FarmDataModel)[source]

Abstract base class of rotor models.

class foxes.core.FarmModel(foxes.core.FarmDataModel)[source]

A FarmDataModel that operates on the farm level (in contrast to a TurbineModel, which allows application to a subset of turbines).

class foxes.core.TurbineModel(foxes.core.FarmDataModel)[source]

Abstract base class for turbine models.

class foxes.core.TurbineType(foxes.core.TurbineModel)[source]

Abstract base class for turbine type models.

class foxes.core.FarmController(foxes.core.FarmDataModel)[source]

Analyses selected turbine models and handles their call.

class foxes.core.Turbine[source]

An individual wind turbine.

class foxes.core.PartialWakesModel(foxes.core.Model)[source]

Abstract base class for partial wakes models.

class foxes.core.WakeFrame(foxes.core.Model)[source]

Abstract base class for wake frames.

class foxes.core.WakeModel(foxes.core.Model)[source]

Abstract base class for wake models.

class foxes.core.TurbineInductionModel(foxes.core.WakeModel)[source]

Abstract base class for turbine induction models.

class foxes.core.WakeK(foxes.core.Model)[source]

Handler for the wake growth parameter k

class foxes.core.WakeSuperposition(foxes.core.Model)[source]

Abstract base class for wake superposition models.

class foxes.core.VerticalProfile(foxes.core.Model)[source]

Abstract base class for vertical profiles.

class foxes.core.AxialInductionModel(foxes.core.Model)[source]

Abstract base class for axial induction models