cs_field_bc_coeffs_t Struct Reference

Field boundary condition descriptor (for variables) More...

#include <cs_field.h>

Collaboration diagram for cs_field_bc_coeffs_t:

Public Member Functions
	cs_field_bc_coeffs_t (void)
	cs_field_bc_coeffs_t (int field_dim)
	~cs_field_bc_coeffs_t ()
cs_span< cs_real_t >	get_val_ext () const
	Return a 1D span view of boundary condition external values. More...
cs::mdspan< cs_real_t, 2, cs::layout::left >	get_val_ext_2d () const
	Return a 2D span view of boundary condition external values (1st dimension: face id, 2nd dimension: field dimension). More...
cs_span< cs_real_t >	get_val_ext_s () const
	Return a 1D span view of boundary condition external scalar values. More...
cs::mdspan< cs_real_t, 2, cs::layout::left >	get_val_ext_v () const
	Return a 2D span view of boundary condition external vector values. More...
cs::mdspan< cs_real_t, 2, cs::layout::left >	get_val_ext_t () const
	Return a 2D span view of boundary condition external tensor values. More...
cs_span< cs_real_t >	get_h_ext () const
	Return a 1D span view of boundary condition external exchange coefficient. More...
cs::mdspan< cs_real_t, 2, cs::layout::left >	get_h_ext_2d () const
	Return a 2D span view of boundary condition external exchange coefficient (1st dimension: face id, 2nd dimension: field dimension). More...
cs_span< cs_real_t >	get_h_ext_s () const
	Return a 1D span view of boundary condition external exchange coefficient. More...
cs::mdspan< cs_real_t, 2, cs::layout::left >	get_h_ext_v () const
	Return a 2D span view of boundary condition vector external exchange coefficients. More...
cs_span< cs_real_t >	get_q_ext () const
	Return a 1D span view of boundary condition prescribed flux. More...
cs::mdspan< cs_real_t, 2, cs::layout::left >	get_q_ext_2d () const
	Return a 2D span view of boundary condition prescribed flux (1st dimension: face id, 2nd dimension: field dimension). More...
cs_span< cs_real_t >	get_q_ext_s () const
	Return a 1D span view of boundary condition prescribed flux. More...
cs::mdspan< cs_real_t, 2, cs::layout::left >	get_q_ext_v () const
	Return a 2D span view of boundary condition vector prescribed flux. More...

Public Attributes
int *	icodcl
cs_real_t *	rcodcl1
cs_real_t *	rcodcl2
cs_real_t *	rcodcl3
cs_real_t *	h_int_tot
cs_real_t *	h_rad
cs_real_t *	flux_rad
cs_real_t *	val_f
cs_real_t *	val_f_pre
cs_real_t *	flux_diff
cs_real_t *	a
cs_real_t *	b
cs_real_t *	af
cs_real_t *	bf
cs_real_t *	ad
cs_real_t *	bd
cs_real_t *	ac
cs_real_t *	bc

Detailed Description

Field boundary condition descriptor (for variables)

Field boundary condition descriptor (for variables)

Constructor & Destructor Documentation

cs_field_bc_coeffs_t() [1/2]

cs_field_bc_coeffs_t ( void  )

inline

cs_field_bc_coeffs_t() [2/2]

cs_field_bc_coeffs_t ( int  field_dim )

inline

Parameters

field_dim

Associated field dimension

~cs_field_bc_coeffs_t()

~cs_field_bc_coeffs_t ( )

inline

Member Function Documentation

get_h_ext()

cs_span< cs_real_t > get_h_ext

(

)

const

Return a 1D span view of boundary condition external exchange coefficient.

Returns

span view of boundary condition external exchange coefficient.

get_h_ext_2d()

cs::mdspan< cs_real_t, 2, cs::layout::left > get_h_ext_2d

(

)

const

Return a 2D span view of boundary condition external exchange coefficient (1st dimension: face id, 2nd dimension: field dimension).

Returns

2D span view of field boundary condition prescribed flux

get_h_ext_s()

cs_span< cs_real_t > get_h_ext_s

(

)

const

Return a 1D span view of boundary condition external exchange coefficient.

This is the same as cs_field_bc_coeffs_t::get_h_ext, with a more explicit naming scheme which is better aligned with s/v/t (scalar/vector/tensor).

Returns

span view of boundary condition external values.

get_h_ext_v()

cs::mdspan< cs_real_t, 2, cs::layout::left > get_h_ext_v

(

)

const

Return a 2D span view of boundary condition vector external exchange coefficients.

Returns

2D span view of field boundary condition external exchange coefficients.

get_q_ext()

cs_span< cs_real_t > get_q_ext

(

)

const

Return a 1D span view of boundary condition prescribed flux.

Returns

span view of boundary condition prescribed flux

get_q_ext_2d()

cs::mdspan< cs_real_t, 2, cs::layout::left > get_q_ext_2d

(

)

const

Return a 2D span view of boundary condition prescribed flux (1st dimension: face id, 2nd dimension: field dimension).

Returns

2D span view of field boundary condition prescribed flux

get_q_ext_s()

cs_span< cs_real_t > get_q_ext_s

(

)

const

Return a 1D span view of boundary condition prescribed flux.

This is the same as cs_field_bc_coeffs_t::get_q_ext, with a more explicit naming scheme which is better aligned with s/v/t (scalar/vector/tensor).

Returns

span view of boundary condition prescribed flux

get_q_ext_v()

cs::mdspan< cs_real_t, 2, cs::layout::left > get_q_ext_v

(

)

const

Return a 2D span view of boundary condition vector prescribed flux.

Returns

2D span view of field boundary condition prescribed flux

get_val_ext()

cs_span< cs_real_t > get_val_ext

(

)

const

Return a 1D span view of boundary condition external values.

Returns

span view of boundary condition external values.

get_val_ext_2d()

cs::mdspan< cs_real_t, 2, cs::layout::left > get_val_ext_2d

(

)

const

Return a 2D span view of boundary condition external values (1st dimension: face id, 2nd dimension: field dimension).

Returns

2D span view of field boundary condition prescribed flux

get_val_ext_s()

cs_span< cs_real_t > get_val_ext_s

(

)

const

Return a 1D span view of boundary condition external scalar values.

This is the same as cs_field_bc_coeffs_t::get_val_ext, with a more explicit naming scheme which is better aligned with s/v/t (scalar/vector/tensor).

Returns

span view of boundary condition external values.

get_val_ext_t()

cs::mdspan< cs_real_t, 2, cs::layout::left > get_val_ext_t

(

)

const

Return a 2D span view of boundary condition external tensor values.

Returns

2D span view of field boundary condition external tensor values.

get_val_ext_v()

cs::mdspan< cs_real_t, 2, cs::layout::left > get_val_ext_v

(

)

const

Return a 2D span view of boundary condition external vector values.

Returns

2D span view of field boundary condition external vector values.

Member Data Documentation

a

a

Explicit coefficient

ac

ac

Explicit coefficient for convection

ad

ad

Explicit coefficient for divergence

af

af

Explicit coefficient for diffusive flux

b

b

Implicit coefficient

bc

bc

Implicit coefficient for convection

bd

bd

Implicit coefficient for divergence

bf

bf

Implicit coefficient for diffusive flux

flux_diff

cs_real_t* flux_diff

flux_rad

cs_real_t* flux_rad

h_int_tot

cs_real_t* h_int_tot

h_rad

cs_real_t* h_rad

icodcl

icodcl

Low-level BC type code

rcodcl1

rcodcl1

1st part of low-level BC values definition

rcodcl2

rcodcl2

2nd part of low-level BC values definition (a.k.a. hext, exterior exchange coefficient)

rcodcl3

rcodcl3

3rd part of low-level BC values definition

val_f

cs_real_t* val_f

val_f_pre

cs_real_t* val_f_pre

---

The documentation for this struct was generated from the following files:

• src/base/cs_field.h
• src/base/cs_field.cpp