cs_hho_vecteq.h File Reference

#include "cs_base.h"
#include "cs_cdo_connect.h"
#include "cs_cdo_local.h"
#include "cs_cdo_quantities.h"
#include "cs_equation_common.h"
#include "cs_equation_param.h"
#include "cs_field.h"
#include "cs_hho_builder.h"
#include "cs_matrix.h"
#include "cs_matrix_assembler.h"
#include "cs_mesh.h"
#include "cs_restart.h"
#include "cs_source_term.h"
#include "cs_time_step.h"

Include dependency graph for cs_hho_vecteq.h:

Go to the source code of this file.

Functions
void	cs_hho_vecteq_init_common (cs_flag_t scheme_flag, const cs_cdo_quantities_t *quant, const cs_cdo_connect_t *connect, const cs_time_step_t *time_step, const cs_matrix_structure_t *ms0, const cs_matrix_structure_t *ms1, const cs_matrix_structure_t *ms2)
	Allocate work buffer and general structures related to HHO schemes Set shared pointers. More...
void	cs_hho_vecteq_get (cs_cell_sys_t **csys, cs_cell_builder_t **cb, cs_hho_builder_t **hhob)
	Retrieve work buffers used for building a CDO system cellwise. More...
void	cs_hho_vecteq_finalize_common (void)
	Free buffers and generic structures related to HHO schemes. More...
void *	cs_hho_vecteq_init_context (const cs_equation_param_t *eqp, int var_id, int bflux_id, cs_equation_builder_t *eqb)
	Initialize a cs_hho_vecteq_t structure storing data useful for managing such a scheme. More...
void *	cs_hho_vecteq_free_context (void *data)
	Destroy a cs_hho_vecteq_t structure. More...
void	cs_hho_vecteq_init_values (cs_real_t t_eval, const int field_id, const cs_mesh_t *mesh, const cs_equation_param_t *eqp, cs_equation_builder_t *eqb, void *context)
	Set the initial values of the variable field taking into account the boundary conditions. Case of vector-valued HHO schemes. More...
void	cs_hho_vecteq_compute_source (const cs_equation_param_t *eqp, cs_equation_builder_t *eqb, void *data)
	Compute the contributions of source terms (store inside builder) More...
void	cs_hho_vecteq_initialize_system (const cs_equation_param_t *eqp, cs_equation_builder_t *eqb, void *data, cs_matrix_t **system_matrix, cs_real_t **system_rhs)
	Create the matrix of the current algebraic system. Allocate and initialize the right-hand side associated to the given data structure. More...
void	cs_hho_vecteq_build_system (const cs_mesh_t *mesh, const cs_real_t *field_val, const cs_equation_param_t *eqp, cs_equation_builder_t *eqb, void *data, cs_real_t *rhs, cs_matrix_t *matrix)
	Build the linear system arising from a scalar convection/diffusion equation with a HHO scheme. One works cellwise and then process to the assembly. More...
void	cs_hho_vecteq_update_field (const cs_real_t *solu, const cs_real_t *rhs, const cs_equation_param_t *eqp, cs_equation_builder_t *eqb, void *data, cs_real_t *field_val)
	Store solution(s) of the linear system into a field structure Update extra-field values required for hybrid discretization. More...
cs_real_t *	cs_hho_vecteq_get_face_values (void *data)
	Get the computed values at faces (DoF used in the linear system are located at primal faces) More...
cs_real_t *	cs_hho_vecteq_get_cell_values (void *data)
	Get the computed values at cells (DoF used in the linear system are located at primal faces) More...
void	cs_hho_vecteq_read_restart (cs_restart_t *restart, const char *eqname, void *scheme_context)
	Read additional arrays (not defined as fields) but useful for the checkpoint/restart process. More...
void	cs_hho_vecteq_write_restart (cs_restart_t *restart, const char *eqname, void *scheme_context)
	Write additional arrays (not defined as fields) but useful for the checkpoint/restart process. More...
void	cs_hho_vecteq_extra_op (const char *eqname, const cs_field_t *field, const cs_equation_param_t *eqp, cs_equation_builder_t *eqb, void *data)
	Predefined extra-operations related to this equation. More...

Function Documentation

cs_hho_vecteq_build_system()

void cs_hho_vecteq_build_system	(	const cs_mesh_t *	mesh,
		const cs_real_t *	field_val,
		const cs_equation_param_t *	eqp,
		cs_equation_builder_t *	eqb,
		void *	data,
		cs_real_t *	rhs,
		cs_matrix_t *	matrix
	)

Build the linear system arising from a scalar convection/diffusion equation with a HHO scheme. One works cellwise and then process to the assembly.

Parameters

[in]	mesh	pointer to a cs_mesh_t structure
[in]	field_val	pointer to the current value of the field
[in]	eqp	pointer to a cs_equation_param_t structure
[in,out]	eqb	pointer to a cs_equation_builder_t structure
[in,out]	data	pointer to cs_hho_vecteq_t structure
[in,out]	rhs	right-hand side
[in,out]	matrix	pointer to cs_matrix_t structure to compute

cs_hho_vecteq_compute_source()

void cs_hho_vecteq_compute_source	(	const cs_equation_param_t *	eqp,
		cs_equation_builder_t *	eqb,
		void *	data
	)

Compute the contributions of source terms (store inside builder)

Parameters

[in]	eqp	pointer to a cs_equation_param_t structure
[in,out]	eqb	pointer to a cs_equation_builder_t structure
[in,out]	data	pointer to a cs_hho_vecteq_t structure

cs_hho_vecteq_extra_op()

void cs_hho_vecteq_extra_op	(	const char *	eqname,
		const cs_field_t *	field,
		const cs_equation_param_t *	eqp,
		cs_equation_builder_t *	eqb,
		void *	data
	)

Predefined extra-operations related to this equation.

Parameters

[in]	eqname	name of the equation
[in]	field	pointer to a field structure
[in]	eqp	pointer to a cs_equation_param_t structure
[in,out]	eqb	pointer to a cs_equation_builder_t structure
[in,out]	data	pointer to cs_hho_vecteq_t structure

cs_hho_vecteq_finalize_common()

void cs_hho_vecteq_finalize_common

(

void

)

Free buffers and generic structures related to HHO schemes.

cs_hho_vecteq_free_context()

void* cs_hho_vecteq_free_context

(

void *

data

)

Destroy a cs_hho_vecteq_t structure.

Parameters

[in,out]

data

pointer to a cs_hho_vecteq_t structure

Returns

a NULL pointer

cs_hho_vecteq_get()

void cs_hho_vecteq_get	(	cs_cell_sys_t **	csys,
		cs_cell_builder_t **	cb,
		cs_hho_builder_t **	hhob
	)

Retrieve work buffers used for building a CDO system cellwise.

Parameters

[out]	csys	pointer to a pointer on a cs_cell_sys_t structure
[out]	cb	pointer to a pointer on a cs_cell_builder_t structure
[out]	hhob	pointer to a pointer on a cs_hho_builder_t structure

cs_hho_vecteq_get_cell_values()

cs_real_t* cs_hho_vecteq_get_cell_values

(

void *

data

)

Get the computed values at cells (DoF used in the linear system are located at primal faces)

Parameters

[in,out]

data

pointer to a data structure cast-on-fly

Returns

a pointer to an array of cs_real_t

cs_hho_vecteq_get_face_values()

cs_real_t* cs_hho_vecteq_get_face_values

(

void *

data

)

Get the computed values at faces (DoF used in the linear system are located at primal faces)

Parameters

[in,out]

data

pointer to a data structure cast-on-fly

Returns

a pointer to an array of cs_real_t

cs_hho_vecteq_init_common()

void cs_hho_vecteq_init_common	(	cs_flag_t	scheme_flag,
		const cs_cdo_quantities_t *	quant,
		const cs_cdo_connect_t *	connect,
		const cs_time_step_t *	time_step,
		const cs_matrix_structure_t *	ms0,
		const cs_matrix_structure_t *	ms1,
		const cs_matrix_structure_t *	ms2
	)

Allocate work buffer and general structures related to HHO schemes Set shared pointers.

Parameters

[in]	scheme_flag	flag to identify which kind of numerical scheme is requested to solve the computational domain
[in]	quant	pointer to a cs_cdo_quantities_t struct.
[in]	connect	pointer to a cs_cdo_connect_t struct.
[in]	time_step	pointer to a cs_time_step_t struct.
[in]	ms0	pointer to a cs_matrix_structure_t struct. (P0)
[in]	ms1	pointer to a cs_matrix_structure_t struct. (P1)
[in]	ms2	pointer to a cs_matrix_structure_t struct. (P2)

cs_hho_vecteq_init_context()

void* cs_hho_vecteq_init_context	(	const cs_equation_param_t *	eqp,
		int	var_id,
		int	bflux_id,
		cs_equation_builder_t *	eqb
	)

Initialize a cs_hho_vecteq_t structure storing data useful for managing such a scheme.

Parameters

[in]	eqp	pointer to a cs_equation_param_t structure
[in]	var_id	id of the variable field
[in]	bflux_id	id of the boundary flux field
[in,out]	eqb	pointer to a cs_equation_builder_t structure

Returns

a pointer to a new allocated cs_hho_vecteq_t structure

cs_hho_vecteq_init_values()

void cs_hho_vecteq_init_values	(	cs_real_t	t_eval,
		const int	field_id,
		const cs_mesh_t *	mesh,
		const cs_equation_param_t *	eqp,
		cs_equation_builder_t *	eqb,
		void *	context
	)

Set the initial values of the variable field taking into account the boundary conditions. Case of vector-valued HHO schemes.

Parameters

[in]	t_eval	time at which one evaluates BCs
[in]	field_id	id related to the variable field of this equation
[in]	mesh	pointer to a cs_mesh_t structure
[in]	eqp	pointer to a cs_equation_param_t structure
[in,out]	eqb	pointer to a cs_equation_builder_t structure
[in,out]	context	pointer to the scheme context (cast on-the-fly)

cs_hho_vecteq_initialize_system()

void cs_hho_vecteq_initialize_system	(	const cs_equation_param_t *	eqp,
		cs_equation_builder_t *	eqb,
		void *	data,
		cs_matrix_t **	system_matrix,
		cs_real_t **	system_rhs
	)

Create the matrix of the current algebraic system. Allocate and initialize the right-hand side associated to the given data structure.

Parameters

[in]	eqp	pointer to a cs_equation_param_t structure
[in,out]	eqb	pointer to a cs_equation_builder_t structure
[in,out]	data	pointer to generic data structure
[in,out]	system_matrix	pointer of pointer to a cs_matrix_t struct.
[in,out]	system_rhs	pointer of pointer to an array of cs_real_t

cs_hho_vecteq_read_restart()

void cs_hho_vecteq_read_restart	(	cs_restart_t *	restart,
		const char *	eqname,
		void *	scheme_context
	)

Read additional arrays (not defined as fields) but useful for the checkpoint/restart process.

Parameters

[in,out]	restart	pointer to cs_restart_t structure
[in]	eqname	name of the related equation
[in]	scheme_context	pointer to a data structure cast on-the-fly

cs_hho_vecteq_update_field()

void cs_hho_vecteq_update_field	(	const cs_real_t *	solu,
		const cs_real_t *	rhs,
		const cs_equation_param_t *	eqp,
		cs_equation_builder_t *	eqb,
		void *	data,
		cs_real_t *	field_val
	)

Store solution(s) of the linear system into a field structure Update extra-field values required for hybrid discretization.

Parameters

[in]	solu	solution array
[in]	rhs	rhs associated to this solution array
[in]	eqp	pointer to a cs_equation_param_t structure
[in,out]	eqb	pointer to a cs_equation_builder_t structure
[in,out]	data	pointer to cs_hho_vecteq_t structure
[in,out]	field_val	pointer to the current value of the field

cs_hho_vecteq_write_restart()

void cs_hho_vecteq_write_restart	(	cs_restart_t *	restart,
		const char *	eqname,
		void *	scheme_context
	)

Write additional arrays (not defined as fields) but useful for the checkpoint/restart process.

Parameters

[in,out]	restart	pointer to cs_restart_t structure
[in]	eqname	name of the related equation
[in]	scheme_context	pointer to a data structure cast on-the-fly