WindModule Class Reference

The WindModule is the main object of the iLand wind module. More...

#include <windmodule.h>

Public Member Functions
	WindModule ()
void	setup ()
	the general setup routine after starting iland More...
void	setupResourceUnit (const ResourceUnit *ru)
	setup of spatial explicit variables (e.g. More...
WindLayers &	layers ()
void	run (const int iteration=-1, const bool execute_from_script=false)
	main function of the disturbance module More...
void	setWindProperties (const double direction_rad, const double speed_ms)
void	setSimulationMode (const bool mode)
bool	simulationMode () const
void	setMaximumIterations (const double maxit)
void	testFetch (double degree_direction)
void	testEffect ()

Static Public Member Functions
static double	cellsize ()

Friends
class	WindScript
class	WindOut
void	nc_calculateFetch (WindCell *begin, WindCell *end)
void	nc_calculateWindImpact (ResourceUnit *unit)

Detailed Description

The WindModule is the main object of the iLand wind module.

The WindModule is the disturbance module for simulation wind and windthrow in iLand.

The setup() function creates the data structures, and the run() function is the main entry point. The main functions are detectEdges(), calculateFetch() and calculateImpact().

Constructor & Destructor Documentation

WindModule()

WindModule::WindModule

(

)

Member Function Documentation

cellsize()

static double WindModule::cellsize ( )

inlinestatic

layers()

WindLayers & WindModule::layers ( )

inline

run()

void WindModule::run	(	const int	iteration = -1,
		const bool	execute_from_script = false
	)

main function of the disturbance module

the run() function executes the wind events

setMaximumIterations()

void WindModule::setMaximumIterations ( const double  maxit )

inline

setSimulationMode()

void WindModule::setSimulationMode ( const bool  mode )

inline

setup()

void WindModule::setup

(

)

the general setup routine after starting iland

setup of general settings from the project file.

the function is invoked from the Plugin.

setupResourceUnit()

void WindModule::setupResourceUnit

(

const ResourceUnit *

ru

)

setup of spatial explicit variables (e.g.

the wind speed modifier) the function is called from the plugin-object.

setWindProperties()

void WindModule::setWindProperties ( const double  direction_rad, const double  speed_ms  )

inline

simulationMode()

bool WindModule::simulationMode ( ) const

inline

testEffect()

void WindModule::testEffect

(

)

testFetch()

void WindModule::testFetch

(

double

degree_direction

)

Friends And Related Function Documentation

nc_calculateFetch

void nc_calculateFetch ( WindCell *  begin, WindCell *  end  )

friend

nc_calculateWindImpact

void nc_calculateWindImpact ( ResourceUnit *  unit )

friend

WindOut

friend class WindOut

friend

WindScript

friend class WindScript

friend

---

The documentation for this class was generated from the following files:

• C:/dev/iland/src/plugins/wind/windmodule.h
• C:/dev/iland/src/plugins/wind/windmodule.cpp