Architecture and Design#

wcomp entirely consists of an interface definition to wake modeling software, a module of data structures to hold wind farm wake simulation results, and plotting functions. The ultimate objective is to provide infrastructure to obtain consistence results from similar wake modeling software with common inputs. Each wake modeling software that implements the interface can be automatically included in the dataset of solutions to characteristic problems.

The package diagram below shows the modules within wcomp and how each relates to the others as dependencies (which modules import which other modules).

The interface to implement by participating wake modeling software is defined in an abstract base class, wcomp.base_interface, and the class diagram is given below.

The following table maps the wake modeling software currently integrated to wcomp to the API documentation for their respective interface files, for reference.