g3d.defs.world.numerics package

Submodules

g3d.defs.world.numerics.irsm module

G3DIRSM static class

class g3d.defs.world.numerics.irsm.G3DIRSM[source]

Bases: object

G3D Implicit Residual Smoothing (IRSM) placeholder

Attributes:

cfl_activate: IRSM activation CFL value (default 1.0)
cfl_crit: IRSM critical CFL value (default 1.2)
cfl_max: IRSM critical CFL max (default 0.0)
irsm_lambda: IRMS lambda value (default lambda = 1.0)
lambda_factor: IRSM lambda factor (default 0.25)
lambda_max: IRSM lambda max value (default 0.0)
lambda_min: IRSM lambda min value (default 1.0)
lambda_specified_by_user: IRSM lambda has been specified by user (default = False)
relax: IRSM under relaxation factor (default 0.9)

Methods

update_lambda()

update IRSM lambda value input: no input needed example: update_lambda()

property cfl_activate: float: IRSM activation CFL value (default 1.0)

property cfl_crit: float: IRSM critical CFL value (default 1.2)

property cfl_max: float: IRSM critical CFL max (default 0.0)

property irsm_lambda: float: IRMS lambda value (default lambda = 1.0)

property lambda_factor: float: IRSM lambda factor (default 0.25)

property lambda_max: float: IRSM lambda max value (default 0.0)

property lambda_min: float: IRSM lambda min value (default 1.0)

property lambda_specified_by_user: bool: IRSM lambda has been specified by user (default = False)

property relax: float: IRSM under relaxation factor (default 0.9)

update_lambda() → None[source]: update IRSM lambda value input: no input needed example: update_lambda()

g3d.defs.world.numerics.limiters module

G3DLimiters static class

class g3d.defs.world.numerics.limiters.G3DLimiters[source]

Bases: object

G3D limiters placeholder

Attributes:

p_max: maximum pressure (default None)
p_min: minimum pressure (default None)
t_max: maximum temperature (default None)
t_min: minimum temperature (default None)

property p_max: float: maximum pressure (default None)

property p_min: float: minimum pressure (default None)

property t_max: float: maximum temperature (default None)

property t_min: float: minimum temperature (default None)

g3d.defs.world.numerics.num module

G3DNum static class

class g3d.defs.world.numerics.num.G3DNum[source]

Bases: object

G3D numerics placeholder

Attributes:

irsm: instance of G3D IRSM placeholder
limiters: instance of G3D limiters placeholder
scheme: instance of G3D numerical scheme placeholder
time: instance of G3D time placeholder

property irsm: G3DIRSM: instance of G3D IRSM placeholder

property limiters: G3DLimiters: instance of G3D limiters placeholder

property scheme: G3DScheme: instance of G3D numerical scheme placeholder

property time: G3DTime: instance of G3D time placeholder

g3d.defs.world.numerics.scheme module

G3DScheme static class

class g3d.defs.world.numerics.scheme.G3DScheme[source]

Bases: object

G3D numerical scheme placeholder

Attributes:

coef_1: convective scheme coefficient 1 (of four coefficients defining the scheme)
coef_2: convective scheme coefficient 2 (of four coefficients defining the scheme)
coef_3: convective scheme coefficient 3 (of four coefficients defining the scheme)
coef_4: convective scheme coefficient 4 (of four coefficients defining the scheme)
convective_scheme: convective scheme of G3DFlow cfd solver
entropy_damp_coef: entropy damping coefficient (default value = 0.0)
shock_damp_coef: shock damping coefficient (default value = 0.0)
shock_damping_mode: shock damping mode (Enum, default value = ShockDampingMode.JAMESON)
use_density_tvd_limiter: use density TVD limiter (default value = False)
use_turbulence_model_tvd_limiter: use turbulence model TVD limiter (default value = False)

Methods

`get_coefs`()	returns an array with coefficients of the convective scheme input: no input example: [c1, c2, c3, c4] = get_coefs()
`numerical_scheme_report`()	prints solver convective scheme input: no input
`set_coefs`(c1, c2, c3, c4)	defining convective scheme by specifying four coefficients input: coefficients (c1, c2, c3, c4)

property coef_1: float: convective scheme coefficient 1 (of four coefficients defining the scheme)

property coef_2: float: convective scheme coefficient 2 (of four coefficients defining the scheme)

property coef_3: float: convective scheme coefficient 3 (of four coefficients defining the scheme)

property coef_4: float: convective scheme coefficient 4 (of four coefficients defining the scheme)

property convective_scheme: Any: convective scheme of G3DFlow cfd solver

property entropy_damp_coef: float: entropy damping coefficient (default value = 0.0)

get_coefs() → ndarray[source]: returns an array with coefficients of the convective scheme input: no input example: [c1, c2, c3, c4] = get_coefs()

numerical_scheme_report() → None[source]: prints solver convective scheme input: no input

set_coefs(c1: float, c2: float, c3: float, c4: float) → None[source]: defining convective scheme by specifying four coefficients input: coefficients (c1, c2, c3, c4)

property shock_damp_coef: float: shock damping coefficient (default value = 0.0)

property shock_damping_mode: Any: shock damping mode (Enum, default value = ShockDampingMode.JAMESON) valid options: JAMESON, DUCROSS_FACE_GRADIENTS, DUCROSS_CELL_GRADIENTS

property use_density_tvd_limiter: bool: use density TVD limiter (default value = False)

property use_turbulence_model_tvd_limiter: bool: use turbulence model TVD limiter (default value = False)

g3d.defs.world.numerics.time module

G3DTime static class

class g3d.defs.world.numerics.time.G3DTime[source]

Bases: object

G3D time placeholder

Attributes:

cfl: solver CFL number (default value = 0.9)
dtime: solver time step (used in combination with time-accurate time mode)
n_sub_iter: maximum number of subiterations (used in combination with dual time stepping time mode)
time_mode: solver time mode (Enum, default value = TIMESTEPTypes.LOCAL_TIME_STEPPING)
time_stepper_mode: solver time stepper mode (Enum, default value = TimeStepperMode.EXPLICIT_RUNGE_KUTTA)

property cfl: float: solver CFL number (default value = 0.9)

property dtime: float: solver time step (used in combination with time-accurate time mode)

property n_sub_iter: int: maximum number of subiterations (used in combination with dual time stepping time mode)

property time_mode: Any: solver time mode (Enum, default value = TIMESTEPTypes.LOCAL_TIME_STEPPING) valid options: LOCAL_TIME_STEPPING, TIME_ACCURATE_CFL, TIME_ACCURATE_CONSTANT_TIME_STEP

property time_stepper_mode: Any: solver time stepper mode (Enum, default value = TimeStepperMode.EXPLICIT_RUNGE_KUTTA) valid options: EXPLICIT_RUNGE_KUTTA, BACKWARD_EULER_DUAL_TIME_STEPPER, CRANK_NICOLSON_DUAL_TIME_STEPPER, TURKEL_BACKWARD_EULER_DUAL_TIME_STEPPER

Module contents

g3d/defs/world/numerics sub library

class g3d.defs.world.numerics.G3DIRSM[source]

Bases: object

G3D Implicit Residual Smoothing (IRSM) placeholder

Attributes:

cfl_activate: IRSM activation CFL value (default 1.0)
cfl_crit: IRSM critical CFL value (default 1.2)
cfl_max: IRSM critical CFL max (default 0.0)
irsm_lambda: IRMS lambda value (default lambda = 1.0)
lambda_factor: IRSM lambda factor (default 0.25)
lambda_max: IRSM lambda max value (default 0.0)
lambda_min: IRSM lambda min value (default 1.0)
lambda_specified_by_user: IRSM lambda has been specified by user (default = False)
relax: IRSM under relaxation factor (default 0.9)

Methods

update_lambda()

update IRSM lambda value input: no input needed example: update_lambda()

property cfl_activate: float: IRSM activation CFL value (default 1.0)

property cfl_crit: float: IRSM critical CFL value (default 1.2)

property cfl_max: float: IRSM critical CFL max (default 0.0)

property irsm_lambda: float: IRMS lambda value (default lambda = 1.0)

property lambda_factor: float: IRSM lambda factor (default 0.25)

property lambda_max: float: IRSM lambda max value (default 0.0)

property lambda_min: float: IRSM lambda min value (default 1.0)

property lambda_specified_by_user: bool: IRSM lambda has been specified by user (default = False)

property relax: float: IRSM under relaxation factor (default 0.9)

update_lambda() → None[source]: update IRSM lambda value input: no input needed example: update_lambda()

class g3d.defs.world.numerics.G3DLimiters[source]

Bases: object

G3D limiters placeholder

Attributes:

p_max: maximum pressure (default None)
p_min: minimum pressure (default None)
t_max: maximum temperature (default None)
t_min: minimum temperature (default None)

property p_max: float: maximum pressure (default None)

property p_min: float: minimum pressure (default None)

property t_max: float: maximum temperature (default None)

property t_min: float: minimum temperature (default None)

class g3d.defs.world.numerics.G3DNum[source]

Bases: object

G3D numerics placeholder

Attributes:

irsm: instance of G3D IRSM placeholder
limiters: instance of G3D limiters placeholder
scheme: instance of G3D numerical scheme placeholder
time: instance of G3D time placeholder

property irsm: G3DIRSM: instance of G3D IRSM placeholder

property limiters: G3DLimiters: instance of G3D limiters placeholder

property scheme: G3DScheme: instance of G3D numerical scheme placeholder

property time: G3DTime: instance of G3D time placeholder

class g3d.defs.world.numerics.G3DScheme[source]

Bases: object

G3D numerical scheme placeholder

Attributes:

coef_1: convective scheme coefficient 1 (of four coefficients defining the scheme)
coef_2: convective scheme coefficient 2 (of four coefficients defining the scheme)
coef_3: convective scheme coefficient 3 (of four coefficients defining the scheme)
coef_4: convective scheme coefficient 4 (of four coefficients defining the scheme)
convective_scheme: convective scheme of G3DFlow cfd solver
entropy_damp_coef: entropy damping coefficient (default value = 0.0)
shock_damp_coef: shock damping coefficient (default value = 0.0)
shock_damping_mode: shock damping mode (Enum, default value = ShockDampingMode.JAMESON)
use_density_tvd_limiter: use density TVD limiter (default value = False)
use_turbulence_model_tvd_limiter: use turbulence model TVD limiter (default value = False)

Methods

`get_coefs`()	returns an array with coefficients of the convective scheme input: no input example: [c1, c2, c3, c4] = get_coefs()
`numerical_scheme_report`()	prints solver convective scheme input: no input
`set_coefs`(c1, c2, c3, c4)	defining convective scheme by specifying four coefficients input: coefficients (c1, c2, c3, c4)

property coef_1: float: convective scheme coefficient 1 (of four coefficients defining the scheme)

property coef_2: float: convective scheme coefficient 2 (of four coefficients defining the scheme)

property coef_3: float: convective scheme coefficient 3 (of four coefficients defining the scheme)

property coef_4: float: convective scheme coefficient 4 (of four coefficients defining the scheme)

property convective_scheme: Any: convective scheme of G3DFlow cfd solver

property entropy_damp_coef: float: entropy damping coefficient (default value = 0.0)

get_coefs() → ndarray[source]: returns an array with coefficients of the convective scheme input: no input example: [c1, c2, c3, c4] = get_coefs()

numerical_scheme_report() → None[source]: prints solver convective scheme input: no input

set_coefs(c1: float, c2: float, c3: float, c4: float) → None[source]: defining convective scheme by specifying four coefficients input: coefficients (c1, c2, c3, c4)

property shock_damp_coef: float: shock damping coefficient (default value = 0.0)

property shock_damping_mode: Any: shock damping mode (Enum, default value = ShockDampingMode.JAMESON) valid options: JAMESON, DUCROSS_FACE_GRADIENTS, DUCROSS_CELL_GRADIENTS

property use_density_tvd_limiter: bool: use density TVD limiter (default value = False)

property use_turbulence_model_tvd_limiter: bool: use turbulence model TVD limiter (default value = False)

class g3d.defs.world.numerics.G3DTime[source]

Bases: object

G3D time placeholder

Attributes:

cfl: solver CFL number (default value = 0.9)
dtime: solver time step (used in combination with time-accurate time mode)
n_sub_iter: maximum number of subiterations (used in combination with dual time stepping time mode)
time_mode: solver time mode (Enum, default value = TIMESTEPTypes.LOCAL_TIME_STEPPING)
time_stepper_mode: solver time stepper mode (Enum, default value = TimeStepperMode.EXPLICIT_RUNGE_KUTTA)

property cfl: float: solver CFL number (default value = 0.9)

property dtime: float: solver time step (used in combination with time-accurate time mode)

property n_sub_iter: int: maximum number of subiterations (used in combination with dual time stepping time mode)

property time_mode: Any: solver time mode (Enum, default value = TIMESTEPTypes.LOCAL_TIME_STEPPING) valid options: LOCAL_TIME_STEPPING, TIME_ACCURATE_CFL, TIME_ACCURATE_CONSTANT_TIME_STEP

property time_stepper_mode: Any: solver time stepper mode (Enum, default value = TimeStepperMode.EXPLICIT_RUNGE_KUTTA) valid options: EXPLICIT_RUNGE_KUTTA, BACKWARD_EULER_DUAL_TIME_STEPPER, CRANK_NICOLSON_DUAL_TIME_STEPPER, TURKEL_BACKWARD_EULER_DUAL_TIME_STEPPER