set_output.c File Reference

Set/retrieve output data attributes. More...

#include "pluto.h"

Functions
void	SetOutput (Data *d, Input *input)
int	SetDumpVar (char *var_name, int out_type, int flag)
double ***	GetUserVar (char *var_name)

Detailed Description

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 SetDumpVar() 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.

Authors

A. Mignone (migno.nosp@m.ne@p.nosp@m.h.uni.nosp@m.to.i.nosp@m.t)

Date

Oct 29, 2012

Function Documentation

double*** GetUserVar

(

char *

var_name

)

return a pointer to the 3D array associated with the variable named 'var_name'.

int SetDumpVar	(	char *	var_name,
		int	out_type,
		int	flag
	)

Include ('flag == YES') or exclude ('flag == NO') the variable associated 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.

Parameters

[in]	var_name	the name of the variable (e.g. "rho", "vx1",...)
[in]	out_type	select the output type (e.g., DBL_OUTPUT, VTK_OUTPUT, and so forth)
[in]	flag	an integer values (YES/NO).

void SetOutput	(	Data *	d,
		Input *	input
	)

Set default attributes (variable names, pointers to data structures, filename extensions, etc...) of the output structures.

Parameters

[in]	d	pointer to Data structure
[in]	input	pointer to input structure