programmer's documentation
Macros | Functions | Variables
cs_cdofb_scaleq.c File Reference
#include "cs_defs.h"
#include <stdio.h>
#include <stdlib.h>
#include <math.h>
#include <float.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_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_post.h"
#include "cs_quadrature.h"
#include "cs_reco.h"
#include "cs_search.h"
#include "cs_source_term.h"
#include "cs_static_condensation.h"
#include "cs_cdofb_priv.h"
#include "cs_cdofb_scaleq.h"
Include dependency graph for cs_cdofb_scaleq.c:

Macros

#define CS_CDOFB_SCALEQ_DBG   0
 
#define CS_CDOFB_SCALEQ_MODULO   10
 

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_cell_structures (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_cdofb_scaleq_t *eqc, const cs_real_t dir_values[], const short int neu_tags[], const cs_real_t field_tn[], cs_cell_sys_t *csys, cs_cell_builder_t *cb)
 Initialize the local structure for the current cell. More...
 
void cs_cdofb_scaleq_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 scalar-valued face-based schemes. Set shared pointers from the main domain members. More...
 
void cs_cdofb_scaleq_get (cs_cell_sys_t **csys, cs_cell_builder_t **cb)
 Retrieve work buffers used for building a CDO system cellwise. More...
 
void cs_cdofb_scaleq_finalize_common (void)
 Free work buffer and general structure related to CDO face-based schemes. More...
 
void * cs_cdofb_scaleq_init_context (const cs_equation_param_t *eqp, cs_equation_builder_t *eqb)
 Initialize a cs_cdofb_scaleq_t structure storing data useful for managing such a scheme. More...
 
void * cs_cdofb_scaleq_free_context (void *data)
 Destroy a cs_cdofb_scaleq_t structure. More...
 
void cs_cdofb_scaleq_compute_source (const cs_equation_param_t *eqp, cs_equation_builder_t *eqb, void *data)
 Compute the contributions of source terms (store inside data) More...
 
void cs_cdofb_scaleq_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_cdofb_scaleq_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 scalar convection/diffusion equation with a CDO face-based scheme. One works cellwise and then process to the assembly. More...
 
void cs_cdofb_scaleq_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...
 
void cs_cdofb_scaleq_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...
 
double * cs_cdofb_scaleq_get_face_values (const void *data)
 Get the computed values at each face. More...
 

Variables

static cs_cell_sys_t ** cs_cdofb_cell_sys = NULL
 
static cs_cell_builder_t ** cs_cdofb_cell_bld = NULL
 
static const cs_cdo_quantities_tcs_shared_quant
 
static const cs_cdo_connect_tcs_shared_connect
 
static const cs_time_step_tcs_shared_time_step
 
static const cs_matrix_structure_tcs_shared_ms
 

Macro Definition Documentation

◆ CS_CDOFB_SCALEQ_DBG

#define CS_CDOFB_SCALEQ_DBG   0

◆ CS_CDOFB_SCALEQ_MODULO

#define CS_CDOFB_SCALEQ_MODULO   10

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]connectpointer to a cs_cdo_connect_t structure
Returns
a pointer to a new allocated cs_cell_builder_t structure

◆ _init_cell_structures()

static void _init_cell_structures ( 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_cdofb_scaleq_t *  eqc,
const cs_real_t  dir_values[],
const short int  neu_tags[],
const cs_real_t  field_tn[],
cs_cell_sys_t csys,
cs_cell_builder_t cb 
)
static

Initialize the local structure for the current cell.

Parameters
[in]cell_flagflag related to the current cell
[in]cmpointer to a cellwise view of the mesh
[in]eqppointer to a cs_equation_param_t structure
[in]eqbpointer to a cs_equation_builder_t structure
[in]eqcpointer to a cs_cdofb_scaleq_t structure
[in]dir_valuesDirichlet values associated to each face
[in]neu_tagsDefinition id related to each Neumann face
[in]field_tnvalues of the field at the last computed time
[in,out]csyspointer to a cellwise view of the system
[in,out]cbpointer to a cellwise builder

◆ cs_cdofb_scaleq_build_system()

void cs_cdofb_scaleq_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 scalar convection/diffusion equation with a CDO face-based scheme. One works cellwise and then process to the assembly.

Parameters
[in]meshpointer to a cs_mesh_t structure
[in]field_valpointer to the current value of the field
[in]dt_curcurrent value of the time step
[in]eqppointer to a cs_equation_param_t structure
[in,out]eqbpointer to a cs_equation_builder_t structure
[in,out]datapointer to cs_cdofb_scaleq_t structure
[in,out]rhsright-hand side
[in,out]matrixpointer to cs_matrix_t structure to compute

◆ cs_cdofb_scaleq_compute_source()

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

Compute the contributions of source terms (store inside data)

Parameters
[in]eqppointer to a cs_equation_param_t structure
[in,out]eqbpointer to a cs_equation_builder_t structure
[in,out]datapointer to a cs_cdofb_scaleq_t structure

◆ cs_cdofb_scaleq_extra_op()

void cs_cdofb_scaleq_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]eqnamename of the equation
[in]fieldpointer to a field structure
[in]eqppointer to a cs_equation_param_t structure
[in,out]eqbpointer to a cs_equation_builder_t structure
[in,out]datapointer to cs_cdofb_scaleq_t structure

◆ cs_cdofb_scaleq_finalize_common()

void cs_cdofb_scaleq_finalize_common ( void  )

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

◆ cs_cdofb_scaleq_free_context()

void* cs_cdofb_scaleq_free_context ( void *  data)

Destroy a cs_cdofb_scaleq_t structure.

Parameters
[in,out]datapointer to a cs_cdofb_scaleq_t structure
Returns
a NULL pointer

◆ cs_cdofb_scaleq_get()

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

Retrieve work buffers used for building a CDO system cellwise.

Parameters
[out]csyspointer to a pointer on a cs_cell_sys_t structure
[out]cbpointer to a pointer on a cs_cell_builder_t structure

◆ cs_cdofb_scaleq_get_face_values()

double* cs_cdofb_scaleq_get_face_values ( const void *  data)

Get the computed values at each face.

Parameters
[in]datapointer to cs_cdofb_scaleq_t structure
Returns
a pointer to an array of double (size n_faces)

◆ cs_cdofb_scaleq_init_common()

void cs_cdofb_scaleq_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 scalar-valued face-based schemes. Set shared pointers from the main domain members.

Parameters
[in]quantadditional mesh quantities struct.
[in]connectpointer to a cs_cdo_connect_t struct.
[in]time_steppointer to a time step structure
[in]mspointer to a cs_matrix_structure_t structure

◆ cs_cdofb_scaleq_init_context()

void* cs_cdofb_scaleq_init_context ( const cs_equation_param_t eqp,
cs_equation_builder_t eqb 
)

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

Parameters
[in]eqppointer to a cs_equation_param_t structure
[in,out]eqbpointer to a cs_equation_builder_t structure
Returns
a pointer to a new allocated cs_cdofb_scaleq_t structure

◆ cs_cdofb_scaleq_initialize_system()

void cs_cdofb_scaleq_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]eqppointer to a cs_equation_param_t structure
[in,out]eqbpointer to a cs_equation_builder_t structure
[in,out]datapointer to cs_cdofb_scaleq_t structure
[in,out]system_matrixpointer of pointer to a cs_matrix_t struct.
[in,out]system_rhspointer of pointer to an array of double

◆ cs_cdofb_scaleq_update_field()

void cs_cdofb_scaleq_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]solusolution array
[in]rhsrhs associated to this solution array
[in]eqppointer to a cs_equation_param_t structure
[in,out]eqbpointer to a cs_equation_builder_t structure
[in,out]datapointer to cs_cdofb_scaleq_t structure
[in,out]field_valpointer to the current value of the field

Variable Documentation

◆ cs_cdofb_cell_bld

cs_cell_builder_t** cs_cdofb_cell_bld = NULL
static

◆ cs_cdofb_cell_sys

cs_cell_sys_t** cs_cdofb_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