fvm_to_histogram.h File Reference

#include "cs_defs.h"
#include "fvm_defs.h"
#include "fvm_nodal.h"
#include "fvm_writer.h"

Include dependency graph for fvm_to_histogram.h:

Go to the source code of this file.

Data Structures
struct	fvm_to_histogram_writer_t

Typedefs
typedef void()	fvm_to_histogram_display_t(cs_real_t var_min, cs_real_t var_max, cs_gnum_t count[], fvm_to_histogram_writer_t *w, char *var_name)

Enumerations
enum	cs_histogram_format_t { CS_HISTOGRAM_TXT, CS_HISTOGRAM_TEX, CS_HISTOGRAM_PNG }

Functions
void *	fvm_to_histogram_init_writer (const char *name, const char *path, const char *options, fvm_writer_time_dep_t time_dependency)
void *	fvm_to_histogram_finalize_writer (void *writer)
void	fvm_to_histogram_set_mesh_time (void *writer, const int time_step, const double time_value)
void	fvm_to_histogram_export_field (void *writer, const fvm_nodal_t *mesh, const char *name, fvm_writer_var_loc_t location, int dimension, cs_interlace_t interlace, int n_parent_lists, const cs_lnum_t parent_num_shift[], cs_datatype_t datatype, int time_step, double time_value, const void *const field_values[])
void	fvm_to_histogram_flush (void *writer)

Typedef Documentation

fvm_to_histogram_display_t

typedef void() fvm_to_histogram_display_t(cs_real_t var_min, cs_real_t var_max, cs_gnum_t count[], fvm_to_histogram_writer_t *w, char *var_name)

Function pointer to display histograms.

parameters: var_min <– minimum variable value var_max <– maximum variable value count <– count for each histogram slice f <– pointer to the histogram file

Enumeration Type Documentation

cs_histogram_format_t

enum cs_histogram_format_t

Enumerator
CS_HISTOGRAM_TXT
CS_HISTOGRAM_TEX
CS_HISTOGRAM_PNG

Function Documentation

fvm_to_histogram_export_field()

void fvm_to_histogram_export_field	(	void *	writer,
		const fvm_nodal_t *	mesh,
		const char *	name,
		fvm_writer_var_loc_t	location,
		int	dimension,
		cs_interlace_t	interlace,
		int	n_parent_lists,
		const cs_lnum_t	parent_num_shift[],
		cs_datatype_t	datatype,
		int	time_step,
		double	time_value,
		const void *const	field_values[]
	)

fvm_to_histogram_finalize_writer()

void* fvm_to_histogram_finalize_writer

(

void *

writer

)

fvm_to_histogram_flush()

void fvm_to_histogram_flush

(

void *

writer

)

fvm_to_histogram_init_writer()

void* fvm_to_histogram_init_writer	(	const char *	name,
		const char *	path,
		const char *	options,
		fvm_writer_time_dep_t	time_dependency
	)

fvm_to_histogram_set_mesh_time()

void fvm_to_histogram_set_mesh_time	(	void *	writer,
		const int	time_step,
		const double	time_value
	)