plugin_src/green/alma.c File Reference

#include <stdio.h>
#include <stdlib.h>
#include <string.h>
#include <math.h>
#include "crusde_api.h"
Include dependency graph for alma.c:

Functions

void read_alma_output (const char *file, float **love_array)
const char * get_name ()
const char * get_version ()
const char * get_authors ()
PluginCategory get_category ()
const char * get_description ()
void register_parameter ()
 Register parameters this Green's function claims from the input.
void register_output_fields ()
 Register output fields for spatial directions this Green's function calculates.
void request_plugins ()
void init ()
 Initialize members that depend on registered values.
void run ()
 Not used in this plugin, left empty!
void clear ()
 Clean-up before this plug-in gets unloaded.
int get_value_at (double **result, int x, int y)
 Returns the Green's Function value at Point(x,y).

Variables

double * p_deg_min
double * p_deg_max
double * p_deg_step
char ** p_file
double * p_kv
double * p_lth
double * p_mode
double * p_ng
double * p_nla
double * p_p
double * p_rheol
double * p_sd
double * p_time_min
double * p_time_max
int x_pos
int y_pos
int z_pos
float ** love_number_h
float ** love_number_k
float ** love_number_l
double backpack [3]

Detailed Description

Isn't truly a Green's function, but provides an interface to ALMA


Function Documentation

void clear (  ) 

Clean-up before this plug-in gets unloaded.

Yet, there is nothing to free here.

const char* get_authors (  ) 
PluginCategory get_category (  ) 

References GREEN_PLUGIN.

const char* get_description (  ) 
const char* get_name (  ) 
int get_value_at ( double **  result,
int  x,
int  y 
)

Returns the Green's Function value at Point(x,y).

TODO!

Parameters:
x The x-Coordinate of the wanted value.
y The y-Coordinate of the wanted value.
Returns:
The value found at Point[y][x]

References NOERROR.

const char* get_version (  ) 
void init (  ) 
void read_alma_output ( const char *  file,
float **  love_array 
)
void register_output_fields (  ) 

Register output fields for spatial directions this Green's function calculates.

This function calls crusde_register_output_field defined in crusde_api.h to register output field in the following order:

  1. x, y, z (horizontal-x, horizontal-y, vertical).

References crusde_info(), crusde_register_output_field(), get_name(), X_FIELD, x_pos, Y_FIELD, y_pos, Z_FIELD, and z_pos.

void register_parameter (  ) 

Register parameters this Green's function claims from the input.

This function calls crusde_register_green_param() defined in crusde_api.h to register references to parameters this Green's function will need to operate properly. 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:

  1. g, XML config identifier is "g" SI-unit: [m/s^2]
  2. E, XML config identifier is "E" SI-unit: [GPa]
  3. nu XML config identifier is "nu" SI-unit: [-]
See also:
register_green_param()
register_parameter() (temp_plugin.c.tmp)

References crusde_register_optional_param_string(), crusde_register_param_double(), get_category(), p_deg_max, p_deg_min, p_deg_step, p_file, p_kv, p_lth, p_mode, p_ng, p_nla, p_p, p_rheol, p_sd, p_time_max, and p_time_min.

void request_plugins (  ) 
void run (  ) 

Not used in this plugin, left empty!


Variable Documentation

double backpack[3]
float** love_number_h

Referenced by init().

float** love_number_k

Referenced by init().

float** love_number_l

Referenced by init().

double* p_deg_max
double* p_deg_min
double* p_deg_step
char** p_file

Referenced by init(), and register_parameter().

double* p_kv

Referenced by init(), and register_parameter().

double* p_lth

Referenced by init(), and register_parameter().

double* p_mode

Referenced by init(), and register_parameter().

double* p_ng

Referenced by init(), and register_parameter().

double* p_nla

Referenced by init(), and register_parameter().

double* p_p
double* p_rheol

Referenced by init(), and register_parameter().

double* p_sd

Referenced by init(), and register_parameter().

double* p_time_max

Referenced by init(), and register_parameter().

double* p_time_min

Referenced by init(), and register_parameter().

int x_pos
int y_pos
int z_pos

Generated on Tue Feb 16 15:18:27 2010 for CrusDe by  doxygen 1.6.1-20091004