windse_driver.driver_functions¶

windse_driver.driver_functions.BlankParameters()¶: returns a nested dictionary that matches the first level of the parameters dictionary

windse_driver.driver_functions.BuildDomain(params)¶

This function build the domain and wind farm objects.

Parameters:	params (`windse.Parameters`) – an overloaded dict containing all parameters.
Returns:	dom (`windse.GenericDomain`) – the domain object that contains all mesh related information. farm (`windse.GenericWindFarm`) – the wind farm object that contains the turbine information.

windse_driver.driver_functions.BuildProblem(params, dom, farm)¶

This function compiles everything into a single problem object and build the variational problem functional.

Parameters:	params (windse.Parameters) – an overloaded dict containing all parameters. dom (windse.GenericDomain) – the domain object that contains all mesh related information. farm (windse.GenericWindFarm) – the wind farm object that contains the turbine information.
Returns:	contains all information about the simulation.
Return type:	problem (windse.GenericProblem)

windse_driver.driver_functions.BuildSolver(params, problem)¶

This function builds the solver object. Solve with solver.Solve()

Parameters:	params (windse.Parameters) – an overloaded dict containing all parameters. problem (windse.GenericProblem) – contains all information about the simulation.
Returns:	solver – contains the solver routines.
Return type:	windse.GenericSolver

windse_driver.driver_functions.DefaultParameters()¶: return the default parameters list

windse_driver.driver_functions.Initialize(params_loc=None)¶

This function initialized the windse parameters.

Parameters:	params_loc (str) – the location of the parameter yaml file.
Returns:	params – an overloaded dict containing all parameters.
Return type:	windse.Parameters

windse_driver.driver_functions.SetupSimulation(params_loc=None)¶

This function automatically sets up the entire simulation. Solve with solver.Solve()

Parameters:	params_loc (str) – the location of the parameter yaml file.
Returns:	params (windse.Parameters) – an overloaded dict containing all parameters. problem (windse.GenericProblem) – contains all information about the simulation. solver (windse.GenericSolver) – contains the solver routines. Solve with solver.Solve()

Functions¶

windse_driver.driver_functions.BlankParameters(): returns a nested dictionary that matches the first level of the parameters dictionary

windse_driver.driver_functions.BuildDomain(params)

This function build the domain and wind farm objects.

Parameters:	params (`windse.Parameters`) – an overloaded dict containing all parameters.
Returns:	dom (`windse.GenericDomain`) – the domain object that contains all mesh related information. farm (`windse.GenericWindFarm`) – the wind farm object that contains the turbine information.

windse_driver.driver_functions.BuildProblem(params, dom, farm)

This function compiles everything into a single problem object and build the variational problem functional.

Parameters:	params (windse.Parameters) – an overloaded dict containing all parameters. dom (windse.GenericDomain) – the domain object that contains all mesh related information. farm (windse.GenericWindFarm) – the wind farm object that contains the turbine information.
Returns:	contains all information about the simulation.
Return type:	problem (windse.GenericProblem)

windse_driver.driver_functions.BuildSolver(params, problem)

This function builds the solver object. Solve with solver.Solve()

Parameters:	params (windse.Parameters) – an overloaded dict containing all parameters. problem (windse.GenericProblem) – contains all information about the simulation.
Returns:	solver – contains the solver routines.
Return type:	windse.GenericSolver

windse_driver.driver_functions.DefaultParameters(): return the default parameters list

windse_driver.driver_functions.Initialize(params_loc=None)

This function initialized the windse parameters.

Parameters:	params_loc (str) – the location of the parameter yaml file.
Returns:	params – an overloaded dict containing all parameters.
Return type:	windse.Parameters

windse_driver.driver_functions.SetupSimulation(params_loc=None)

This function automatically sets up the entire simulation. Solve with solver.Solve()

Parameters:	params_loc (str) – the location of the parameter yaml file.
Returns:	params (windse.Parameters) – an overloaded dict containing all parameters. problem (windse.GenericProblem) – contains all information about the simulation. solver (windse.GenericSolver) – contains the solver routines. Solve with solver.Solve()