9.1
general documentation
Macros | Functions
cs_boundary_conditions_set_coeffs.cpp File Reference

Translation of the boundary conditions given by the user in a form that fits the solver. More...

#include "base/cs_defs.h"
#include <stdarg.h>
#include <stdio.h>
#include <stdlib.h>
#include <string.h>
#include <assert.h>
#include <math.h>
#include "bft/bft_printf.h"
#include "base/cs_1d_wall_thermal.h"
#include "base/cs_ale.h"
#include "base/cs_array.h"
#include "base/cs_assert.h"
#include "base/cs_base.h"
#include "base/cs_boundary.h"
#include "base/cs_boundary_conditions.h"
#include "base/cs_boundary_conditions_check.h"
#include "base/cs_boundary_conditions_coupling.h"
#include "base/cs_boundary_conditions_set_coeffs_symmetry.h"
#include "base/cs_boundary_conditions_set_coeffs_turb.h"
#include "base/cs_boundary_conditions_type.h"
#include "cfbl/cs_cf_boundary_conditions.h"
#include "base/cs_coupling.h"
#include "base/cs_dispatch.h"
#include "base/cs_field.h"
#include "base/cs_field_default.h"
#include "base/cs_field_operator.h"
#include "base/cs_field_pointer.h"
#include "alge/cs_gradient_boundary.h"
#include "gui/cs_gui_boundary_conditions.h"
#include "gui/cs_gui_mobile_mesh.h"
#include "gui/cs_gui_util.h"
#include "base/cs_ht_convert.h"
#include "base/cs_internal_coupling.h"
#include "turb/cs_les_inflow.h"
#include "base/cs_log.h"
#include "base/cs_mem.h"
#include "mesh/cs_mesh.h"
#include "mesh/cs_mesh_quantities.h"
#include "base/cs_mobile_structures.h"
#include "base/cs_parall.h"
#include "base/cs_parameters.h"
#include "base/cs_physical_constants.h"
#include "pprt/cs_physical_model.h"
#include "base/cs_porous_model.h"
#include "base/cs_profiling.h"
#include "base/cs_prototypes.h"
#include "rayt/cs_rad_transfer.h"
#include "rayt/cs_rad_transfer_bcs.h"
#include "base/cs_sat_coupling.h"
#include "base/cs_syr_coupling.h"
#include "base/cs_thermal_model.h"
#include "base/cs_time_step.h"
#include "turb/cs_turbulence_model.h"
#include "base/cs_turbomachinery.h"
#include "base/cs_velocity_pressure.h"
#include "base/cs_vof.h"
#include "base/cs_wall_condensation.h"
#include "base/cs_wall_condensation_1d_thermal.h"
#include "base/cs_rotation.h"
#include "atmo/cs_atmo.h"
#include "ctwr/cs_ctwr_boundary_conditions.h"
#include "cogz/cs_combustion_boundary_conditions.h"
#include "comb/cs_coal_boundary_conditions.h"
#include "base/cs_boundary_conditions_set_coeffs.h"

Macros

#define NOZPPM   2000 /* max number of boundary conditions zone */
 

Functions

template<bool need_flux_reconstruction>
static void _compute_bc_flux_grad (cs_dispatch_context &ctx, const int hyd_p_flag, const cs_real_t f_ext[][3], const cs_field_bc_coeffs_t *bc_coeffs, const cs_real_t val_ip_g[], const cs_real_t val_ip_d[], cs_real_t val_f[], cs_real_t flux[])
 
static void _compute_bc_grad (cs_dispatch_context &ctx, const int hyd_p_flag, const cs_real_t f_ext[][3], const cs_field_bc_coeffs_t *bc_coeffs, const cs_real_t val_ip_g[], cs_real_t val_f[])
 
static void _compute_bc_flux (cs_dispatch_context &ctx, const cs_field_bc_coeffs_t *bc_coeffs, const bool need_flux_reconstruction, const cs_real_t val_ip_d[], cs_real_t flux[])
 
void cs_boundary_conditions_set_coeffs (int nvar, int iterns, int isvhb, int italim, int itrfin, int ineefl, int itrfup, int isostd[], cs_real_t *visvdr, cs_real_t hbord[], cs_real_t theipb[], int nftcdt)
 Translation of the boundary conditions given by the user in a form that fits to the solver. More...
 
void cs_boundary_conditions_set_coeffs_init (void)
 Initialization of boundary condition arrays. More...
 
void cs_boundary_conditions_set_convective_outlet_scalar (cs_real_t &a, cs_real_t &af, cs_real_t &b, cs_real_t &bf, cs_real_t pimp, cs_real_t cfl, cs_real_t hint)
 Set convective oulet boundary condition for a scalar. More...
 
CS_F_HOST_DEVICE void cs_boundary_conditions_set_generalized_sym_vector_aniso (cs_real_t a[3], cs_real_t af[3], cs_real_t b[3][3], cs_real_t bf[3][3], const cs_real_t pimpv[3], const cs_real_t qimpv[3], const cs_real_t hint[6], const cs_nreal_t normal[3])
 Set generalized BC for an anisotropic symmetric vector for a given face. More...
 
void cs_boundary_conditions_set_generalized_dirichlet_vector_aniso (cs_real_t a[3], cs_real_t af[3], cs_real_t b[3][3], cs_real_t bf[3][3], const cs_real_t pimpv[3], const cs_real_t qimpv[3], const cs_real_t hint[6], const cs_nreal_t normal[3])
 Set generalized Dirichlet BC for an anisotropic vector for a given face. More...
 
void cs_boundary_conditions_update_bc_coeff_face_values (cs_dispatch_context &ctx, const cs_field_t *f, const cs_field_bc_coeffs_t *bc_coeffs, const int inc, const cs_equation_param_t *eqp, const bool need_compute_bc_grad, const bool need_compute_bc_flux, int hyd_p_flag, cs_real_t f_ext[][3], cs_real_t visel[], cs_real_t viscel[][6], const cs_real_t weighb[], const cs_real_t pvar[], cs_real_t val_f[], cs_real_t flux[])
 Update face value for gradient and diffusion when solving in increment. More...
 
void cs_boundary_conditions_update_bc_coeff_face_values (cs_dispatch_context &ctx, cs_field_t *f, const cs_equation_param_t *eqp, const bool need_compute_bc_grad, const bool need_compute_bc_flux, int hyd_p_flag, cs_real_t f_ext[][3], cs_real_t viscel[][6], const cs_real_t weighb[], const cs_real_t pvar[])
 Update boundary coefficient face values for gradient and diffusion when solving for a given field. More...
 
template<cs_lnum_t stride>
void cs_boundary_conditions_update_bc_coeff_face_values_strided (cs_dispatch_context &ctx, cs_field_t *f, const cs_field_bc_coeffs_t *bc_coeffs, const int inc, const cs_equation_param_t *eqp, const cs_real_t pvar[][stride], cs_real_t val_ip[][stride], cs_real_t val_f[][stride], cs_real_t flux[][stride], cs_real_t flux_lim[][stride])
 Update face value for gradient and diffusion when solving in increments. More...
 
template<cs_lnum_t stride>
void cs_boundary_conditions_update_bc_coeff_face_values_strided (cs_dispatch_context &ctx, cs_field_t *f, const cs_real_t pvar[][stride])
 
template void cs_boundary_conditions_update_bc_coeff_face_values_strided (cs_dispatch_context &ctx, cs_field_t *f, const cs_field_bc_coeffs_t *bc_coeffs, const int inc, const cs_equation_param_t *eqp, const cs_real_t pvar[][3], cs_real_t val_ip[][3], cs_real_t val_f[][3], cs_real_t flux[][3], cs_real_t flux_lim[][3])
 
template void cs_boundary_conditions_update_bc_coeff_face_values_strided (cs_dispatch_context &ctx, cs_field_t *f, const cs_field_bc_coeffs_t *bc_coeffs, const int inc, const cs_equation_param_t *eqp, const cs_real_t pvar[][6], cs_real_t val_ip[][6], cs_real_t val_f[][6], cs_real_t flux[][6], cs_real_t flux_lim[][6])
 
template void cs_boundary_conditions_update_bc_coeff_face_values_strided (cs_dispatch_context &ctx, cs_field_t *f, const cs_real_t pvar[][3])
 
template void cs_boundary_conditions_update_bc_coeff_face_values_strided (cs_dispatch_context &ctx, cs_field_t *f, const cs_real_t pvar[][6])
 
void cs_boundary_conditions_ensure_bc_coeff_face_values_allocated (cs_field_bc_coeffs_t *bc_coeffs, cs_lnum_t n_b_faces, cs_lnum_t dim, cs_alloc_mode_t amode, bool limiter)
 Allocate BC coefficients face values if needed. More...
 
void cs_init_bc_coeffs_solve (cs_bc_coeffs_solve_t &c, cs_lnum_t n_b_faces, cs_lnum_t stride, cs_alloc_mode_t amode, bool limiter)
 Initialize boundary condition coefficients solve arrays. More...
 
void cs_clear_bc_coeffs_solve (cs_bc_coeffs_solve_t &c)
 Free boundary condition coefficients solve arrays. More...
 

Detailed Description

Translation of the boundary conditions given by the user in a form that fits the solver.

Boundary condition coefficients computation.

Macro Definition Documentation

◆ NOZPPM

#define NOZPPM   2000 /* max number of boundary conditions zone */

Function Documentation

◆ _compute_bc_flux()

static void _compute_bc_flux ( cs_dispatch_context &  ctx,
const cs_field_bc_coeffs_t *  bc_coeffs,
const bool  need_flux_reconstruction,
const cs_real_t  val_ip_d[],
cs_real_t  flux[] 
)
static

◆ _compute_bc_flux_grad()

static void _compute_bc_flux_grad ( cs_dispatch_context &  ctx,
const int  hyd_p_flag,
const cs_real_t  f_ext[][3],
const cs_field_bc_coeffs_t *  bc_coeffs,
const cs_real_t  val_ip_g[],
const cs_real_t  val_ip_d[],
cs_real_t  val_f[],
cs_real_t  flux[] 
)
static

◆ _compute_bc_grad()

static void _compute_bc_grad ( cs_dispatch_context &  ctx,
const int  hyd_p_flag,
const cs_real_t  f_ext[][3],
const cs_field_bc_coeffs_t *  bc_coeffs,
const cs_real_t  val_ip_g[],
cs_real_t  val_f[] 
)
static

◆ cs_boundary_conditions_ensure_bc_coeff_face_values_allocated()

void cs_boundary_conditions_ensure_bc_coeff_face_values_allocated ( cs_field_bc_coeffs_t *  bc_coeffs,
cs_lnum_t  n_b_faces,
cs_lnum_t  dim,
cs_alloc_mode_t  amode,
bool  limiter 
)

Allocate BC coefficients face values if needed.

Parameters
[in,out]bc_coeffspointer to boundary conditions coefficients.
[in]n_b_facesnumber of boundary faces
[in]dimassociated field dimension
[in]amodeallocation mode
[in]limiteris a limiter active ?

◆ cs_boundary_conditions_set_coeffs()

void cs_boundary_conditions_set_coeffs ( int  nvar,
int  iterns,
int  isvhb,
int  italim,
int  itrfin,
int  ineefl,
int  itrfup,
int  isostd[],
cs_real_t *  visvdr,
cs_real_t  hbord[],
cs_real_t  theipb[],
int  nftcdt 
)

Translation of the boundary conditions given by the user in a form that fits to the solver.

The values at a boundary face $ \fib $ stored in the face center $ \centf $ of the variable $ P $ and its diffusive flux $ Q $ are written as:

\[ P_{\face} = A_P^g + B_P^g P_{\centi} \]

and

\[ Q_{\face} = A_P^f + B_P^f P_{\centi} \]

where $ P_\centi $ is the value of the variable $ P $ at the neighboring cell.

Warning
  • If we consider an increment of a variable, the boundary conditions read:

    \[ \delta P_{\face} = B_P^g \delta P_{\centi} \]

    and

    \[ \delta Q_{\face} = -B_P^f \delta P_{\centi} \]

  • For a vector field such as the velocity $ \vect{u} $ the boundary conditions may read:

    \[ \vect{u}_{\face} = \vect{A}_u^g + \tens{B}_u^g \vect{u}_{\centi} \]

    and

    \[ \vect{Q}_{\face} = \vect{A}_u^f + \tens{B}_u^f \vect{u}_{\centi} \]

    where $ \tens{B}_u^g $ and $ \tens{B}_u^f $ are 3x3 tensor matrix which coupled velocity components next to a boundary.

Please refer to the boundary conditions section of the theory guide for more informations, as well as the condli section.

Parameters
[in]nvartotal number of variables
[in]iternsiteration number on Navier-Stokes equations
[in]isvhbid of field whose exchange coeffient should be saved at the walls, or -1.
[in]italimfor ALE
[in]itrfinLast velocity-pressure sub-iteration indicator
[in]ineeflfor ALE
[in]itrfupUpdate after velocity-pressure sub-iterations
[in,out]isostdindicator for standard outlet and reference face index
[in]dttime step (per cell)
[in,out]visvdrdynamic viscosity after V. Driest damping in boundary cells
[out]hbordexchange coefficient at boundary
[out]theipbvalue of thermal scalar at $ \centip $ f boundary cells
[in]nftcdtGlobal indicator of condensation source terms (ie. sum on the processors of nfbpcd) cells associated to the face with condensation phenomenon

◆ cs_boundary_conditions_set_coeffs_init()

void cs_boundary_conditions_set_coeffs_init ( void  )

Initialization of boundary condition arrays.

◆ cs_boundary_conditions_set_convective_outlet_scalar()

void cs_boundary_conditions_set_convective_outlet_scalar ( cs_real_t &  a,
cs_real_t &  af,
cs_real_t &  b,
cs_real_t &  bf,
cs_real_t  pimp,
cs_real_t  cfl,
cs_real_t  hint 
)

Set convective oulet boundary condition for a scalar.

Parameters
[out]aexplicit BC coefficient for gradients
[out]afexplicit BC coefficient for diffusive flux
[out]bimplicit BC coefficient for gradients
[out]bfimplicit BC coefficient for diffusive flux
[in]pimpflux value to impose
[in]cfllocal Courant number used to convect
[in]hintinternal exchange coefficient

◆ cs_boundary_conditions_set_generalized_dirichlet_vector_aniso()

void cs_boundary_conditions_set_generalized_dirichlet_vector_aniso ( cs_real_t  a[3],
cs_real_t  af[3],
cs_real_t  b[3][3],
cs_real_t  bf[3][3],
const cs_real_t  pimpv[3],
const cs_real_t  qimpv[3],
const cs_real_t  hint[6],
const cs_nreal_t  normal[3] 
)

Set generalized Dirichlet BC for an anisotropic vector for a given face.

Parameters
[out]aexplicit BC coefficient for gradients
[out]afexplicit BC coefficient for diffusive flux
[out]bimplicit BC coefficient for gradients
[out]bfimplicit BC coefficient for diffusive flux
[in]pimpvDirichlet value to impose on the tangential components
[in]qimpvflux value to impose on the normal component
[in]hintinternal exchange coefficient
[in]normalunit normal

◆ cs_boundary_conditions_set_generalized_sym_vector_aniso()

CS_F_HOST_DEVICE void cs_boundary_conditions_set_generalized_sym_vector_aniso ( cs_real_t  a[3],
cs_real_t  af[3],
cs_real_t  b[3][3],
cs_real_t  bf[3][3],
const cs_real_t  pimpv[3],
const cs_real_t  qimpv[3],
const cs_real_t  hint[6],
const cs_nreal_t  normal[3] 
)

Set generalized BC for an anisotropic symmetric vector for a given face.

Parameters
[out]aexplicit BC coefficient for gradients
[out]afexplicit BC coefficient for diffusive flux
[out]bimplicit BC coefficient for gradients
[out]bfimplicit BC coefficient for diffusive flux
[in]pimpvDirichlet value to impose on the normal component
[in]qimpvflux value to impose on the tangential components
[in]hintinternal exchange coefficient
[in]normalunit normal

◆ cs_boundary_conditions_update_bc_coeff_face_values() [1/2]

void cs_boundary_conditions_update_bc_coeff_face_values ( cs_dispatch_context &  ctx,
const cs_field_t *  f,
const cs_field_bc_coeffs_t *  bc_coeffs,
const int  inc,
const cs_equation_param_t *  eqp,
const bool  need_compute_bc_grad,
const bool  need_compute_bc_flux,
int  hyd_p_flag,
cs_real_t  f_ext[][3],
cs_real_t  visel[],
cs_real_t  viscel[][6],
const cs_real_t  weighb[],
const cs_real_t  pvar[],
cs_real_t  val_f[],
cs_real_t  flux[] 
)

Update face value for gradient and diffusion when solving in increment.

Parameters
[in]ctxreference to dispatch context
[in]fpointer to field
[in]bc_coeffsboundary condition structure
[in]inc0 if an increment, 1 otherwise
[in]eqpequation parameters
[in]need_compute_bc_gradval_f must be computed
[in]need_compute_bc_fluxflux must be computed
[in]hyd_p_flaghydrostatic pressure indicator
[in]f_extexterior force generating pressure
[in]viselviscosity by cell, or nullptr
[in]viscelsymmetric cell tensor $ \tens{\mu}_\celli $, or nullptr
[in]weighbboundary face weight for cells i in case of tensor diffusion, or nullptr
[in]varvariable values at cell centers
[in,out]var_fface values for the gradient computation
[in,out]fluxface values for the diffusion computation

◆ cs_boundary_conditions_update_bc_coeff_face_values() [2/2]

void cs_boundary_conditions_update_bc_coeff_face_values ( cs_dispatch_context &  ctx,
cs_field_t *  f,
const cs_equation_param_t *  eqp,
const bool  need_compute_bc_grad,
const bool  need_compute_bc_flux,
int  hyd_p_flag,
cs_real_t  f_ext[][3],
cs_real_t  viscel[][6],
const cs_real_t  weighb[],
const cs_real_t  pvar[] 
)

Update boundary coefficient face values for gradient and diffusion when solving for a given field.

Parameters
[in]ctxreference to dispatch context
[in,out]fpointer to field
[in]eqpequation parameters
[in]need_compute_bc_gradval_f must be computed
[in]need_compute_bc_fluxflux must be computed
[in]hyd_p_flagflag for hydrostatic pressure
[in]f_extexterior force generating pressure
[in]viscelsymmetric cell tensor $ \tens{\mu}_\celli $, or nullptr
[in]weighbboundary face weight for cells i in case of tensor diffusion, or nullptr
[in]pvarvariable values at cell centers

◆ cs_boundary_conditions_update_bc_coeff_face_values_strided() [1/6]

template void cs_boundary_conditions_update_bc_coeff_face_values_strided ( cs_dispatch_context &  ctx,
cs_field_t *  f,
const cs_field_bc_coeffs_t *  bc_coeffs,
const int  inc,
const cs_equation_param_t *  eqp,
const cs_real_t  pvar[][3],
cs_real_t  val_ip[][3],
cs_real_t  val_f[][3],
cs_real_t  flux[][3],
cs_real_t  flux_lim[][3] 
)

◆ cs_boundary_conditions_update_bc_coeff_face_values_strided() [2/6]

template void cs_boundary_conditions_update_bc_coeff_face_values_strided ( cs_dispatch_context &  ctx,
cs_field_t *  f,
const cs_field_bc_coeffs_t *  bc_coeffs,
const int  inc,
const cs_equation_param_t *  eqp,
const cs_real_t  pvar[][6],
cs_real_t  val_ip[][6],
cs_real_t  val_f[][6],
cs_real_t  flux[][6],
cs_real_t  flux_lim[][6] 
)

◆ cs_boundary_conditions_update_bc_coeff_face_values_strided() [3/6]

void cs_boundary_conditions_update_bc_coeff_face_values_strided ( cs_dispatch_context &  ctx,
cs_field_t *  f,
const cs_field_bc_coeffs_t *  bc_coeffs,
const int  inc,
const cs_equation_param_t *  eqp,
const cs_real_t  pvar[][stride],
cs_real_t  val_ip[][stride],
cs_real_t  val_f[][stride],
cs_real_t  flux[][stride],
cs_real_t  flux_lim[][stride] 
)

Update face value for gradient and diffusion when solving in increments.

Parameters
[in]ctxreference to dispatch context
[in]fpointer to field
[in]bc_coeffsboundary condition structure for the variable
[in]inc0 if an increment, 1 otherwise
[in]eqpequation parameters
[in]pvarvariable values at cell centers
[in,out]var_ipboundary variable values at I' position
[in,out]var_fface values for the gradient computation
[in,out]var_f_dface values for the diffusion computation
[in,out]var_f_d_limface values for the diffusion computation (with limiter)

◆ cs_boundary_conditions_update_bc_coeff_face_values_strided() [4/6]

template void cs_boundary_conditions_update_bc_coeff_face_values_strided ( cs_dispatch_context &  ctx,
cs_field_t *  f,
const cs_real_t  pvar[][3] 
)

◆ cs_boundary_conditions_update_bc_coeff_face_values_strided() [5/6]

template void cs_boundary_conditions_update_bc_coeff_face_values_strided ( cs_dispatch_context &  ctx,
cs_field_t *  f,
const cs_real_t  pvar[][6] 
)

◆ cs_boundary_conditions_update_bc_coeff_face_values_strided() [6/6]

void cs_boundary_conditions_update_bc_coeff_face_values_strided ( cs_dispatch_context &  ctx,
cs_field_t *  f,
const cs_real_t  pvar[][stride] 
)

◆ cs_clear_bc_coeffs_solve()

void cs_clear_bc_coeffs_solve ( cs_bc_coeffs_solve_t &  c)

Free boundary condition coefficients solve arrays.

Parameters
[in,out]creference to structure to initialize.

◆ cs_init_bc_coeffs_solve()

void cs_init_bc_coeffs_solve ( cs_bc_coeffs_solve_t &  c,
cs_lnum_t  n_b_faces,
cs_lnum_t  stride,
cs_alloc_mode_t  amode,
bool  limiter 
)

Initialize boundary condition coefficients solve arrays.

Parameters
[in,out]creference to structure to initialize.
[in]n_b_facesnumber of boundary faces
[in]stridevariable dimension
[in]amodeallocation mode
[in]limiteris a limiter active ?