PLUTO
4.4-patch2
|
Set/retrieve output data attributes. More...
#include "pluto.h"
Functions | |
void | SetOutput (Data *d, Runtime *runtime) |
int | SetOutputVar (char *var_name, int output_type, int flag) |
int | GetOutputVarNames (int output_type, char *var_name[NVAR]) |
double *** | GetUserVar (char *var_name) |
The function SetOutput() sets, for each output data type (DBL, FLT, VTK etc..) the default attributes of the corresponding Output structures. These include the variable name, a pointer to the actual 3D array, the centering of the variable (center/staggered), a conditional inclusion flag (telling if the corresponding variable has to be written in the specified format), and so on.
The function SetOutputVar() can be used to include or exclude a given variable to be written using a particular output format.
The function GetUserVar() returns the memory address to a user-defined 3D array.
int GetOutputVarNames | ( | int | output_type, |
char * | var_name[NVAR] | ||
) |
Return the number and the names of the variables being written to disk with a particular output type.
[in] | output_type | The output type (e.g. FLT_OUTPUT) |
[out] | var_names | An array of strings containing the actual variable names. |
double*** GetUserVar | ( | char * | var_name | ) |
return a pointer to the 3D array associated with the variable named 'var_name'.
int SetOutputVar | ( | char * | var_name, |
int | output_type, | ||
int | flag | ||
) |
Include ('flag == YES') or exclude ('flag == NO') the variable corresponding to 'var_name' in or from the output type 'out_type'. If 'out_type' corresponds to an image (ppm or png), create a correspdonding Image structure.
[in] | var_name | the name of the variable (e.g. "rho", "vx1",...) |
[in] | output_type | select the output type (e.g., DBL_OUTPUT, VTK_OUTPUT, and so forth) |
[in] | flag | an integer values (YES/NO). |