cs_field_default.h File Reference

#include "cs_defs.h"
#include "cs_equation_param.h"

Include dependency graph for cs_field_default.h:

Go to the source code of this file.

Functions
int	cs_variable_cdo_field_create (const char *name, const char *label, int location_id, int dim, int has_previous)
	Add a field shared between CDO and legacy schemes. This field is related to a general solved variable, with default options. More...
int	cs_variable_field_create (const char *name, const char *label, int location_id, int dim)
	Add field defining a general solved variable, with default options. More...
cs_equation_param_t *	cs_field_get_equation_param (cs_field_t *f)
	Access a field's equation parameters. More...
const cs_equation_param_t *	cs_field_get_equation_param_const (const cs_field_t *f)
	Access a field's equation parameters for read only. More...
cs_field_t *	cs_field_get_variance (const cs_field_t *f)
	For a given field, returns field defined as its variance, if present. More...
void	cs_field_build_bc_codes_all (void)
	Allocate and map boundary condition coefficients for all variable fields. More...
void	cs_field_free_bc_codes_all (void)
	Deallocate and unmap boundary condition coefficients for all variable fields. More...
void	cs_field_map_and_init_bcs (void)
	Initialize all field BC coefficients. More...
int	cs_field_n_scalar_fields (void)
	Return the number of defined scalar fields. More...

Function Documentation

cs_field_build_bc_codes_all()

void cs_field_build_bc_codes_all

(

void

)

Allocate and map boundary condition coefficients for all variable fields.

cs_field_free_bc_codes_all()

void cs_field_free_bc_codes_all

(

void

)

Deallocate and unmap boundary condition coefficients for all variable fields.

cs_field_get_equation_param()

cs_equation_param_t * cs_field_get_equation_param

(

cs_field_t *

f

)

Access a field's equation parameters.

If the equation parameters were never initialized, they will be initialized based on the current defaults.

If the field does not have associated equation paremeters (i.e. is not a variable field or is a CDO field (which is referenced by but does not directly reference equations), nullptr is returned.

Parameters

[in,out]

f

pointer to associated field

Returns

pointer to field's equation parameters, or nullptr

cs_field_get_equation_param_const()

const cs_equation_param_t * cs_field_get_equation_param_const

(

const cs_field_t *

f

)

Access a field's equation parameters for read only.

If the equation parameters were never initialized, the current default parameters will be returned instead.

If the field does not have associated equation parameters (i.e. is not a variable field or is a CDO field (which is referenced by but does not directly reference equations), nullptr is returned.

Parameters

[in]

f

pointer to associated field

Returns

const-qualified pointer to field's equation parameters, or nullptr

cs_field_get_variance()

cs_field_t * cs_field_get_variance

(

const cs_field_t *

f

)

For a given field, returns field defined as its variance, if present.

Parameters

[in]

f

field

Returns

pointer to matching variance (variable) field, or nullptr.

cs_field_map_and_init_bcs()

void cs_field_map_and_init_bcs

(

void

)

Initialize all field BC coefficients.

cs_field_n_scalar_fields()

int cs_field_n_scalar_fields

(

void

)

Return the number of defined scalar fields.

Returns

number of legacy FV scalar variavble fields.

cs_variable_cdo_field_create()

int cs_variable_cdo_field_create	(	const char *	name,
		const char *	label,
		int	location_id,
		int	dim,
		int	has_previous
	)

Add a field shared between CDO and legacy schemes. This field is related to a general solved variable, with default options.

Parameters

[in]	name	field name
[in]	label	field default label, or empty
[in]	location_id	id of associated location
[in]	dim	field dimension
[in]	has_previous	no if lower than 1

Returns

newly defined field id

cs_variable_field_create()

int cs_variable_field_create	(	const char *	name,
		const char *	label,
		int	location_id,
		int	dim
	)

Add field defining a general solved variable, with default options.

Parameters

[in]	name	field name
[in]	label	field default label, or empty
[in]	location_id	id of associated location
[in]	dim	field dimension

Returns

newly defined field id