plugin_src/load/disk_load.c File Reference

#include <stdio.h>
#include <math.h>
#include <stdlib.h>
#include "crusde_api.h"

Include dependency graph for disk_load.c:

Functions
const char *	get_name ()
const char *	get_version ()
const char *	get_authors ()
const char *	get_description ()
PluginCategory	get_category ()
void	run ()
	empty
void	clear ()
	empty
void	request_plugins ()
	empty
void	register_output_fields ()
	empty
void	init ()
	Initialize members that depend on registered values.
void	register_parameter ()
	Register parameters this load function claims from the input.
double	get_value_at (int x, int y)
	Returns the Load of a disk at Point (x,y) at time t.
void	set_history_function (loadhistory_exec_function history)
Variables
double *	p_height [100]
double *	p_radius [100]
double *	p_x [100]
double *	p_y [100]
double *	p_rho [100]
loadhistory_exec_function	history_function [100]
double	disk_height
double	disk_radius
double	disk_x
double	disk_y
double	rho
double	dS
double	all_const
double	rho_dS_const
int	my_id = 0

Detailed Description

Implements the simple case of a disk load put on a 2 dimensional area.

Function Documentation

void clear ( )

empty

const char* get_authors ( )

PluginCategory get_category ( )

References LOAD_PLUGIN.

const char* get_description ( )

const char* get_name ( )

double get_value_at	(	int	x,
		int	y
	)

Returns the Load of a disk at Point (x,y) at time t.

Computes the euclidean distance of Point (x,y) to (center_x, center_y). If this distance is less or equal to disk_radius the load will be returned, zero otherwise.

Parameters:

	x	The x-Coordinate of the wanted value.
	y	The y-Coordinate of the wanted value.
	t	The time-Coordinate of the wanted value (set to NO_TIME in non-temporal modelling environment).

Returns:: The load at Point (x,y,t).

References all_const, crusde_get_current_load_component(), crusde_get_gridsize(), crusde_get_min_x(), crusde_get_min_y(), disk_height, disk_radius, disk_x, disk_y, dS, my_id, p_height, p_radius, p_rho, p_x, p_y, rho, rho_dS_const, xx, and yy.

const char* get_version ( )

void init ( )

Initialize members that depend on registered values.

This function must not be called before register_parameter() unless none of the necessary values depends on parameters provided by the user, which are only set after they have been registered. This function is called some time after register_parameter().

void register_output_fields ( )

empty

void register_parameter ( )

Register parameters this load function claims from the input.

This function calls register_load_param() defined in crusde_api.h to register references to parameters this Green's function will need to operate properly. For command line use the order of registration in this function defines the identification of parameters in the command line string (i.e. './green -LfirstRegistered/secondRegistered/...'). In case an XML is used to configure the experiment, the reference to this parameter will be identified by the string passed as second argument to register_green_param().

This function registers the references in the following order:

disk_height, XML config identifier is "height", SI-unit [m]
disk_radius, XML config identifier is "radius", SI-unit [m]
disk_x, XML config identifier is "center_x", SI-unit [m] (Lambert * -# disk_y, XML config identifier is "center_y", SI-unit [m] (Lambert coordinate)
rho, XML config identifier is "rho", SI-unit [kg/m^3]