GfsVariable

Collaboration diagram for GfsVariable:

Classes
	GfsHydrostaticPressure
	GfsVariableAge
	GfsVariableBoolean
	GfsVariableCurvature
	GfsVariableDiagonal
	GfsVariableDistance
	GfsVariableFiltered
	GfsVariableFunction
	GfsVariableMetric
	GfsVariableResidual
	GfsVariableTracer
Functions
GfsVariable *	gfs_variable_new (GfsVariableClass *klass, GfsDomain *domain, const gchar *name, const gchar *description)
GfsVariable *	gfs_variable_from_name (GSList *i, const gchar *name)
GSList *	gfs_variables_from_list (GSList *i, gchar *list, gchar **error)
void	gfs_variables_swap (GfsVariable *v1, GfsVariable *v2)
void	gfs_variable_set_vector (GfsVariable **v, guint n)
void	gfs_variable_set_tensor (GfsVariable *t[2][2])
GfsVariable *	gfs_variable_clone (GfsVariable *v, gchar *name)

---

Detailed Description

Base class for scalar fields.

See also:

Syntax reference

---

Function Documentation

GfsVariable* gfs_variable_clone	(	GfsVariable *	v,
		gchar *	name
	)

Parameters:

v	a #GfsVariable.
name	a name.

Returns:

a new #GfsVariable called name and clone of v.

GfsVariable* gfs_variable_from_name	(	GSList *	i,
		const gchar *	name
	)

Parameters:

i	the list of available #GfsVariable.
name	the name of the variable to find.

Returns:

the #GfsVariable name or NULL if this variable name does not exist.

Here is the caller graph for this function:

GfsVariable* gfs_variable_new	(	GfsVariableClass *	klass,
		GfsDomain *	domain,
		const gchar *	name,
		const gchar *	description
	)

Parameters:

klass	a #GfsVariableClass.
domain	a #GfsDomain.
name	the name of the variable or NULL.
description	the variable description or NULL.

Returns:

a newly allocated #GfsVariable or NULL if a variable named name already exists in domain.

Here is the call graph for this function:

Here is the caller graph for this function:

void gfs_variable_set_tensor

(

GfsVariable *

t[2][2]

)

Parameters:

t	the components of the 2x2 tensor.

Sets t[0][0],...,t[1][1] as components of a tensor.

void gfs_variable_set_vector	(	GfsVariable **	v,
		guint	n
	)

Parameters:

v	the components of the vector.
n	the vector dimension.

Sets v[0],...,v[n-1] as components of a vector quantity.

GSList* gfs_variables_from_list	(	GSList *	i,
		gchar *	list,
		gchar **	error
	)

Parameters:

i	the list of available #GfsVariable.
list	a malloc'ed string containing comma separated variable names.
error	where to return the variable name in case of error.

Returns:

a list of variables or NULL in case of error, in which case *error points to the name of the unknown variable.

Here is the call graph for this function:

void gfs_variables_swap	(	GfsVariable *	v1,
		GfsVariable *	v2
	)

Parameters:

v1	a #GfsVariable.
v2	a #GfsVariable.

Swaps the values of v1 and v2, belonging to the same #GfsDomain.

Here is the caller graph for this function: