Build an algebraic CDO vertex-based system for unsteady convection-diffusion-reaction of vector-valued equations with source terms. More...

#include "cs_defs.h"
#include <stdio.h>
#include <stdlib.h>
#include <math.h>
#include <assert.h>
#include <string.h>
#include <bft_mem.h>
#include "cs_cdo_advection.h"
#include "cs_cdo_bc.h"
#include "cs_cdo_diffusion.h"
#include "cs_cdo_local.h"
#include "cs_cdo_time.h"
#include "cs_equation_bc.h"
#include "cs_equation_common.h"
#include "cs_hodge.h"
#include "cs_log.h"
#include "cs_math.h"
#include "cs_mesh_location.h"
#include "cs_param.h"
#include "cs_post.h"
#include "cs_quadrature.h"
#include "cs_reco.h"
#include "cs_scheme_geometry.h"
#include "cs_search.h"
#include "cs_source_term.h"
#include "cs_timer.h"
#include "cs_cdovb_vecteq.h"

Include dependency graph for cs_cdovb_vecteq.c:

Functions
static cs_cell_builder_t *	_cell_builder_create (const cs_cdo_connect_t *connect)
	Initialize the local builder structure used for building the system cellwise. More...

static void	_init_vb_cell_system (const cs_flag_t cell_flag, const cs_cell_mesh_t cm, const cs_equation_param_t eqp, const cs_equation_builder_t eqb, const cs_real_t dir_values[], const short int neu_tags[], const cs_real_t field_tn[], cs_real_t t_eval, cs_cell_sys_t csys, cs_cell_builder_t *cb)
	Initialize the local structure for the current cell. More...

bool	cs_cdovb_vecteq_is_initialized (void)
	Check if the generic structures for building a CDO-Vb scheme are allocated. More...

void	cs_cdovb_vecteq_init_common (const cs_cdo_quantities_t quant, const cs_cdo_connect_t connect, const cs_time_step_t time_step, const cs_matrix_structure_t ms)
	Allocate work buffer and general structures related to CDO vertex-based schemes Set shared pointers. More...

void	cs_cdovb_vecteq_get (cs_cell_sys_t csys, cs_cell_builder_t cb)
	Retrieve work buffers used for building a CDO system cellwise. More...

void	cs_cdovb_vecteq_finalize_common (void)
	Free work buffer and general structure related to CDO vertex-based schemes. More...

void *	cs_cdovb_vecteq_init_context (const cs_equation_param_t eqp, int var_id, int bflux_id, cs_equation_builder_t eqb)
	Initialize a cs_cdovb_vecteq_t structure storing data useful for building and managing such a scheme. More...

void *	cs_cdovb_vecteq_free_context (void *builder)
	Destroy a cs_cdovb_vecteq_t structure. More...

void	cs_cdovb_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 builder structure. More...

void	cs_cdovb_vecteq_set_dir_bc (const cs_mesh_t mesh, const cs_equation_param_t eqp, cs_equation_builder_t *eqb, cs_real_t t_eval, cs_real_t field_val[])
	Set the boundary conditions known from the settings when the fields stem from a vector CDO vertex-based scheme. More...

void	cs_cdovb_vecteq_build_system (const cs_mesh_t mesh, const cs_real_t field_val, double dt_cur, 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 vector convection/diffusion equation with a CDO vertex-based scheme. One works cellwise and then process to the assembly. More...

void	cs_cdovb_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 if required (for hybrid discretization) More...

cs_real_t *	cs_cdovb_vecteq_get_vertex_values (void *context)
	Retrieve an array of values at mesh vertices for the variable field associated to the given context The lifecycle of this array is managed by the code. So one does not have to free the return pointer. More...

cs_real_t *	cs_cdovb_vecteq_get_cell_values (void *context)
	Compute an array of values at mesh cells by interpolating the variable field associated to the given context located at mesh vertices The lifecycle of this array is managed by the code. So one does not have to free the return pointer. More...

void	cs_cdovb_vecteq_compute_flux_across_plane (const cs_real_t normal[], const cs_real_t pdi, int ml_id, const cs_equation_param_t eqp, cs_equation_builder_t eqb, void data, double d_flux, double c_flux)
	Compute the diffusive and convective flux across a list of faces. More...

void	cs_cdovb_vecteq_cellwise_diff_flux (const cs_real_t values, const cs_equation_param_t eqp, cs_real_t t_eval, cs_equation_builder_t eqb, void data, cs_flag_t location, cs_real_t *diff_flux)
	Cellwise computation of the diffusive flux. More...

void	cs_cdovb_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...

Variables
static cs_cell_sys_t **	cs_cdovb_cell_sys = NULL

static cs_cell_builder_t **	cs_cdovb_cell_bld = NULL

static const cs_cdo_quantities_t *	cs_shared_quant

static const cs_cdo_connect_t *	cs_shared_connect

static const cs_time_step_t *	cs_shared_time_step

static const cs_matrix_structure_t *	cs_shared_ms

Detailed Description

Build an algebraic CDO vertex-based system for unsteady convection-diffusion-reaction of vector-valued equations with source terms.

Function Documentation

◆ _cell_builder_create()

static cs_cell_builder_t* _cell_builder_create ( const cs_cdo_connect_t * connect )

static

Initialize the local builder structure used for building the system cellwise.

Parameters

[in] connect pointer to a cs_cdo_connect_t structure

Returns: a pointer to a new allocated cs_cell_builder_t structure

◆ _init_vb_cell_system()

static void _init_vb_cell_system	(	const cs_flag_t	cell_flag,
		const cs_cell_mesh_t *	cm,
		const cs_equation_param_t *	eqp,
		const cs_equation_builder_t *	eqb,
		const cs_real_t	dir_values[],
		const short int	neu_tags[],
		const cs_real_t	field_tn[],
		cs_real_t	t_eval,
		cs_cell_sys_t *	csys,
		cs_cell_builder_t *	cb
	)

static

Initialize the local structure for the current cell.

Parameters

[in]	cell_flag	flag related to the current cell
[in]	cm	pointer to a cellwise view of the mesh
[in]	eqp	pointer to a cs_equation_param_t structure
[in]	eqb	pointer to a cs_equation_builder_t structure
[in]	dir_values	Dirichlet values associated to each vertex
[in]	neu_tags	definition id related to each Neumann face
[in]	field_tn	values of the field at the last computed time
[in]	t_eval	time at which one performs the evaluation
[in,out]	csys	pointer to a cellwise view of the system
[in,out]	cb	pointer to a cellwise builder

◆ cs_cdovb_vecteq_build_system()

void cs_cdovb_vecteq_build_system	(	const cs_mesh_t *	mesh,
		const cs_real_t *	field_val,
		double	dt_cur,
		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 vector convection/diffusion equation with a CDO vertex-based 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 vertex field
[in]	dt_cur	current value of the time step
[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_cdovcb_vecteq_t structure
[in,out]	rhs	right-hand side
[in,out]	matrix	pointer to cs_matrix_t structure to compute

◆ cs_cdovb_vecteq_cellwise_diff_flux()

void cs_cdovb_vecteq_cellwise_diff_flux	(	const cs_real_t *	values,
		const cs_equation_param_t *	eqp,
		cs_real_t	t_eval,
		cs_equation_builder_t *	eqb,
		void *	data,
		cs_flag_t	location,
		cs_real_t *	diff_flux
	)

Cellwise computation of the diffusive flux.

Parameters

[in]	values	discrete values for the potential
[in]	eqp	pointer to a cs_equation_param_t structure
[in]	t_eval	time at which one performs the evaluation
[in,out]	eqb	pointer to a cs_equation_builder_t structure
[in,out]	data	pointer to cs_cdovb_vecteq_t structure
[in,out]	location	where the flux is defined
[in,out]	diff_flux	value of the diffusive flux

◆ cs_cdovb_vecteq_compute_flux_across_plane()

void cs_cdovb_vecteq_compute_flux_across_plane	(	const cs_real_t	normal[],
		const cs_real_t *	pdi,
		int	ml_id,
		const cs_equation_param_t *	eqp,
		cs_equation_builder_t *	eqb,
		void *	data,
		double *	d_flux,
		double *	c_flux
	)

Compute the diffusive and convective flux across a list of faces.

Parameters

[in]	normal	indicate in which direction flux is > 0
[in]	pdi	pointer to an array of field values
[in]	ml_id	id related to a cs_mesh_location_t struct.
[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 data specific for this scheme
[in,out]	d_flux	pointer to the value of the diffusive flux
[in,out]	c_flux	pointer to the value of the convective flux

◆ cs_cdovb_vecteq_extra_op()

void cs_cdovb_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_cdovb_vecteq_t structure

◆ cs_cdovb_vecteq_finalize_common()

void cs_cdovb_vecteq_finalize_common ( void )

Free work buffer and general structure related to CDO vertex-based schemes.

◆ cs_cdovb_vecteq_free_context()

void* cs_cdovb_vecteq_free_context ( void * builder )

Destroy a cs_cdovb_vecteq_t structure.

Parameters

[in,out] builder pointer to a cs_cdovb_vecteq_t structure

Returns: a NULL pointer

◆ cs_cdovb_vecteq_get()

void cs_cdovb_vecteq_get	(	cs_cell_sys_t **	csys,
		cs_cell_builder_t **	cb
	)

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

◆ cs_cdovb_vecteq_get_cell_values()

cs_real_t* cs_cdovb_vecteq_get_cell_values ( void * context )

Compute an array of values at mesh cells by interpolating the variable field associated to the given context located at mesh vertices The lifecycle of this array is managed by the code. So one does not have to free the return pointer.

Parameters

[in,out] context pointer to a data structure cast on-the-fly

Returns: a pointer to an array of cs_real_t

◆ cs_cdovb_vecteq_get_vertex_values()

cs_real_t* cs_cdovb_vecteq_get_vertex_values ( void * context )

Retrieve an array of values at mesh vertices for the variable field associated to the given context The lifecycle of this array is managed by the code. So one does not have to free the return pointer.

Parameters

[in,out] context pointer to a data structure cast on-the-fly

Returns: a pointer to an array of cs_real_t

◆ cs_cdovb_vecteq_init_common()

void cs_cdovb_vecteq_init_common	(	const cs_cdo_quantities_t *	quant,
		const cs_cdo_connect_t *	connect,
		const cs_time_step_t *	time_step,
		const cs_matrix_structure_t *	ms
	)

Allocate work buffer and general structures related to CDO vertex-based schemes Set shared pointers.

Parameters

[in]	quant	additional mesh quantities struct.
[in]	connect	pointer to a cs_cdo_connect_t struct.
[in]	time_step	pointer to a time step structure
[in]	ms	pointer to a cs_matrix_structure_t structure

◆ cs_cdovb_vecteq_init_context()

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

Initialize a cs_cdovb_vecteq_t structure storing data useful for building and 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_cdovb_vecteq_t structure

◆ cs_cdovb_vecteq_initialize_system()

void cs_cdovb_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 builder 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 cs_cdovb_vecteq_t 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 double

◆ cs_cdovb_vecteq_is_initialized()

bool cs_cdovb_vecteq_is_initialized ( void )

Check if the generic structures for building a CDO-Vb scheme are allocated.

Returns: true or false

◆ cs_cdovb_vecteq_set_dir_bc()

void cs_cdovb_vecteq_set_dir_bc	(	const cs_mesh_t *	mesh,
		const cs_equation_param_t *	eqp,
		cs_equation_builder_t *	eqb,
		cs_real_t	t_eval,
		cs_real_t	field_val[]
	)

Set the boundary conditions known from the settings when the fields stem from a vector CDO vertex-based scheme.

Parameters

[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]	t_eval	time at which one evaluates BCs
[in,out]	field_val	pointer to the values of the variable field

◆ cs_cdovb_vecteq_update_field()

void cs_cdovb_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 if 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_cdovb_vecteq_t structure
[in,out]	field_val	pointer to the current value of the field

Variable Documentation

◆ cs_cdovb_cell_bld

cs_cell_builder_t** cs_cdovb_cell_bld = NULL

static

◆ cs_cdovb_cell_sys

cs_cell_sys_t** cs_cdovb_cell_sys = NULL

static

◆ cs_shared_connect

const cs_cdo_connect_t* cs_shared_connect

static

◆ cs_shared_ms

const cs_matrix_structure_t* cs_shared_ms

static

◆ cs_shared_quant

const cs_cdo_quantities_t* cs_shared_quant

static

◆ cs_shared_time_step

const cs_time_step_t* cs_shared_time_step

static

Functions

Variables

Detailed Description

Function Documentation

◆ _cell_builder_create()

◆ _init_vb_cell_system()

◆ cs_cdovb_vecteq_build_system()

◆ cs_cdovb_vecteq_cellwise_diff_flux()

◆ cs_cdovb_vecteq_compute_flux_across_plane()

◆ cs_cdovb_vecteq_extra_op()

◆ cs_cdovb_vecteq_finalize_common()

◆ cs_cdovb_vecteq_free_context()

◆ cs_cdovb_vecteq_get()

◆ cs_cdovb_vecteq_get_cell_values()

◆ cs_cdovb_vecteq_get_vertex_values()

◆ cs_cdovb_vecteq_init_common()

◆ cs_cdovb_vecteq_init_context()

◆ cs_cdovb_vecteq_initialize_system()

◆ cs_cdovb_vecteq_is_initialized()

◆ cs_cdovb_vecteq_set_dir_bc()

◆ cs_cdovb_vecteq_update_field()

Variable Documentation

◆ cs_cdovb_cell_bld

◆ cs_cdovb_cell_sys

◆ cs_shared_connect

◆ cs_shared_ms

◆ cs_shared_quant

◆ cs_shared_time_step