g3d.flow package

Subpackages

Module contents

g3d/flow sub library

class g3d.flow.G2DAxiFlow(*args: Any, **kwargs: Any)[source]

Bases: G2DFlow

Attributes:
calculator
return:

dom
return:

solver
return:

tag

tag (string) used for identification

Methods

add_BCMod(*args, **kwargs)

add_TVD_limiter(m)

add_to_nstep(N)

auxvr()

bc_update_conservative(boco)

bc_update_primitive(boco)

bc_update_speed_of_sound(boco)

cell_get_block(kc)

cell_get_ijk(kc)

check_cell_metrics(ic)

copy(e)

copies data from specified entity input: entity example: copy(e)

export_field(field, **kwargs)

export_flow(*args, **kwargs)

export_mesh(*args, **kwargs)

export_scalar(var, **kwargs)

export_scalars(variables, **kwargs)

export_velocity_gradients(*args, **kwargs)

generate_mesh_from_pipe_data(q1d)

get_auxv_array([var])

get_auxv_arrays()

get_block_sizes(im)

get_cell(im, i, j, k)

get_cell_centers()

get_cons_array([var])

get_cons_arrays()

get_gas()

get_gas_properties()

get_n_cells()

get_n_faces()

get_n_ghost_cells()

get_n_ghost_nodes()

get_n_nodes()

get_new_Auxv()

get_new_BoCo(*args, **kwargs)

get_new_Cons()

get_new_Q1DPipe()

get_new_Region()

get_new_matrix()

get_node(im, i, j, k)

get_node_coordinates()

get_post_array([var])

get_post_arrays()

get_residual()

get_shock_capturing_field()

get_streamtube_normal([idx])

get_time()

get_volume([idx])

header(*args, **kwargs)

prints a header with specified information input: info optional input: dashes (default='='), scrw (default=80), number of blank lines after dashes n_space (default=1) example: header(info='header info')

hline(*args, **kwargs)

prints horizontal line optional input (kwargs): dashes (default='-'), scrw (default=80) example: hline(dashes='*', scrw=90)

import_boundary_definitions(**kwargs)

import_flow_data(*args, **kwargs)

import_g3d_flow_data(*args, **kwargs)

import_mesh(*args, **kwargs)

initialize_block_flow_field(im, f)

initialize_flow_field(f)

initialize_from_conservative(ro, ru, rv, rw, et)

initialize_from_primitive(p, u, v, w, t)

initialize_linear(ql, qr[, direction])

initialize_region_flow_field(r, f)

jobname_append(name)

extends jobname with the specified string input: name example: jobname_append(name)

node_get_block(kp)

node_get_ijk(kp)

plot_field_2D(field[, im, k])

plot_flow_2D([im, k])

plot_probe_array(var, im, i0, j0, k0, idir, ...)

plot_scalar_2D(var[, im, k])

plot_scalars_2D(variables[, im, k])

print()

prints entity data

remove_TVD_limiter(m)

set(*args, **kwargs)

sets code parameters according to specifications input: args, kwargs example: set(args, kwargs)

set_convection_scheme_coefs(c1, c2, c3, c4)

set_damp(fp, fc)

set_from_key_value(key, value)

sets code parameters from specified key => value data input: key, value valid keys for G3DCode base class: 'verbose', 'silent/quiet', 'jobname', 'working_directory', 'dimension', 'cuda', 'prof' example: set_from_key_value(key, value)

set_gas_properties(g, R)

update_BC(boco)

update_BC_family(*args, **kwargs)

update_BC_type(*args, **kwargs)

check_FMP_metrics

diff_flux_check

export_cell_volume

export_inverse_cell_volume

flux_check

ltsp_test

run

step_test
class g3d.flow.G2DFlow(*args: Any, **kwargs: Any)[source]

Bases: SolverEnv

Attributes:
calculator
return:

dom
return:

solver
return:

tag

tag (string) used for identification

Methods

add_BCMod(*args, **kwargs)

add_TVD_limiter(m)

add_to_nstep(N)

auxvr()

bc_update_conservative(boco)

bc_update_primitive(boco)

bc_update_speed_of_sound(boco)

cell_get_block(kc)

cell_get_ijk(kc)

check_cell_metrics(ic)

copy(e)

copies data from specified entity input: entity example: copy(e)

export_field(field, **kwargs)

export_flow(*args, **kwargs)

export_mesh(*args, **kwargs)

export_scalar(var, **kwargs)

export_scalars(variables, **kwargs)

export_velocity_gradients(*args, **kwargs)

generate_mesh_from_pipe_data(q1d)

get_auxv_array([var])

get_auxv_arrays()

get_block_sizes(im)

get_cell(im, i, j, k)

get_cell_centers()

get_cons_array([var])

get_cons_arrays()

get_gas()

get_gas_properties()

get_n_cells()

get_n_faces()

get_n_ghost_cells()

get_n_ghost_nodes()

get_n_nodes()

get_new_Auxv()

get_new_BoCo(*args, **kwargs)

get_new_Cons()

get_new_Q1DPipe()

get_new_Region()

get_new_matrix()

get_node(im, i, j, k)

get_node_coordinates()

get_post_array([var])

get_post_arrays()

get_residual()

get_shock_capturing_field()

get_streamtube_normal([idx])

get_time()

get_volume([idx])

header(*args, **kwargs)

prints a header with specified information input: info optional input: dashes (default='='), scrw (default=80), number of blank lines after dashes n_space (default=1) example: header(info='header info')

hline(*args, **kwargs)

prints horizontal line optional input (kwargs): dashes (default='-'), scrw (default=80) example: hline(dashes='*', scrw=90)

import_boundary_definitions(**kwargs)

import_flow_data(*args, **kwargs)

import_g3d_flow_data(*args, **kwargs)

import_mesh(*args, **kwargs)

initialize_block_flow_field(im, f)

initialize_flow_field(f)

initialize_from_conservative(ro, ru, rv, rw, et)

initialize_from_primitive(p, u, v, w, t)

initialize_linear(ql, qr[, direction])

initialize_region_flow_field(r, f)

jobname_append(name)

extends jobname with the specified string input: name example: jobname_append(name)

node_get_block(kp)

node_get_ijk(kp)

plot_field_2D(field[, im, k])

plot_flow_2D([im, k])

plot_probe_array(var, im, i0, j0, k0, idir, ...)

plot_scalar_2D(var[, im, k])

plot_scalars_2D(variables[, im, k])

print()

prints entity data

remove_TVD_limiter(m)

set(*args, **kwargs)

sets code parameters according to specifications input: args, kwargs example: set(args, kwargs)

set_convection_scheme_coefs(c1, c2, c3, c4)

set_damp(fp, fc)

set_from_key_value(key, value)

sets code parameters from specified key => value data input: key, value valid keys for G3DCode base class: 'verbose', 'silent/quiet', 'jobname', 'working_directory', 'dimension', 'cuda', 'prof' example: set_from_key_value(key, value)

set_gas_properties(g, R)

update_BC(boco)

update_BC_family(*args, **kwargs)

update_BC_type(*args, **kwargs)

check_FMP_metrics

diff_flux_check

export_cell_volume

export_inverse_cell_volume

flux_check

ltsp_test

run

step_test
class g3d.flow.G3DFlow(*args: Any, **kwargs: Any)[source]

Bases: SolverEnv

Attributes:
calculator
return:

dom
return:

solver
return:

tag

tag (string) used for identification

Methods

add_BCMod(*args, **kwargs)

add_TVD_limiter(m)

add_to_nstep(N)

auxvr()

bc_update_conservative(boco)

bc_update_primitive(boco)

bc_update_speed_of_sound(boco)

cell_get_block(kc)

cell_get_ijk(kc)

check_cell_metrics(ic)

copy(e)

copies data from specified entity input: entity example: copy(e)

export_field(field, **kwargs)

export_flow(*args, **kwargs)

export_mesh(*args, **kwargs)

export_scalar(var, **kwargs)

export_scalars(variables, **kwargs)

export_velocity_gradients(*args, **kwargs)

generate_mesh_from_pipe_data(q1d)

get_auxv_array([var])

get_auxv_arrays()

get_block_sizes(im)

get_cell(im, i, j, k)

get_cell_centers()

get_cons_array([var])

get_cons_arrays()

get_gas()

get_gas_properties()

get_n_cells()

get_n_faces()

get_n_ghost_cells()

get_n_ghost_nodes()

get_n_nodes()

get_new_Auxv()

get_new_BoCo(*args, **kwargs)

get_new_Cons()

get_new_Q1DPipe()

get_new_Region()

get_new_matrix()

get_node(im, i, j, k)

get_node_coordinates()

get_post_array([var])

get_post_arrays()

get_residual()

get_shock_capturing_field()

get_streamtube_normal([idx])

get_time()

get_volume([idx])

header(*args, **kwargs)

prints a header with specified information input: info optional input: dashes (default='='), scrw (default=80), number of blank lines after dashes n_space (default=1) example: header(info='header info')

hline(*args, **kwargs)

prints horizontal line optional input (kwargs): dashes (default='-'), scrw (default=80) example: hline(dashes='*', scrw=90)

import_boundary_definitions(**kwargs)

import_flow_data(*args, **kwargs)

import_g3d_flow_data(*args, **kwargs)

import_mesh(*args, **kwargs)

initialize_block_flow_field(im, f)

initialize_flow_field(f)

initialize_from_conservative(ro, ru, rv, rw, et)

initialize_from_primitive(p, u, v, w, t)

initialize_linear(ql, qr[, direction])

initialize_region_flow_field(r, f)

jobname_append(name)

extends jobname with the specified string input: name example: jobname_append(name)

node_get_block(kp)

node_get_ijk(kp)

plot_field_2D(field[, im, k])

plot_flow_2D([im, k])

plot_probe_array(var, im, i0, j0, k0, idir, ...)

plot_scalar_2D(var[, im, k])

plot_scalars_2D(variables[, im, k])

print()

prints entity data

remove_TVD_limiter(m)

set(*args, **kwargs)

sets code parameters according to specifications input: args, kwargs example: set(args, kwargs)

set_convection_scheme_coefs(c1, c2, c3, c4)

set_damp(fp, fc)

set_from_key_value(key, value)

sets code parameters from specified key => value data input: key, value valid keys for G3DCode base class: 'verbose', 'silent/quiet', 'jobname', 'working_directory', 'dimension', 'cuda', 'prof' example: set_from_key_value(key, value)

set_gas_properties(g, R)

update_BC(boco)

update_BC_family(*args, **kwargs)

update_BC_type(*args, **kwargs)

check_FMP_metrics

diff_flux_check

export_cell_volume

export_inverse_cell_volume

flux_check

ltsp_test

run

step_test
class g3d.flow.Q1DFlow(*args: Any, **kwargs: Any)[source]

Bases: SolverEnv

Attributes:
calculator
return:

dom
return:

solver
return:

tag

tag (string) used for identification

Methods

add_BCMod(*args, **kwargs)

add_TVD_limiter(m)

add_to_nstep(N)

auxvr()

bc_update_conservative(boco)

bc_update_primitive(boco)

bc_update_speed_of_sound(boco)

cell_get_block(kc)

cell_get_ijk(kc)

check_cell_metrics(ic)

copy(e)

copies data from specified entity input: entity example: copy(e)

export_field(field, **kwargs)

export_flow(*args, **kwargs)

export_mesh(*args, **kwargs)

export_scalar(var, **kwargs)

export_scalars(variables, **kwargs)

export_velocity_gradients(*args, **kwargs)

generate_mesh_from_pipe_data(q1d)

get_auxv_array([var])

get_auxv_arrays()

get_block_sizes(im)

get_cell(im, i, j, k)

get_cell_centers()

get_cons_array([var])

get_cons_arrays()

get_gas()

get_gas_properties()

get_n_cells()

get_n_faces()

get_n_ghost_cells()

get_n_ghost_nodes()

get_n_nodes()

get_new_Auxv()

get_new_BoCo(*args, **kwargs)

get_new_Cons()

get_new_Q1DPipe()

get_new_Region()

get_new_matrix()

get_node(im, i, j, k)

get_node_coordinates()

get_post_array([var])

get_post_arrays()

get_residual()

get_shock_capturing_field()

get_streamtube_normal([idx])

get_time()

get_volume([idx])

header(*args, **kwargs)

prints a header with specified information input: info optional input: dashes (default='='), scrw (default=80), number of blank lines after dashes n_space (default=1) example: header(info='header info')

hline(*args, **kwargs)

prints horizontal line optional input (kwargs): dashes (default='-'), scrw (default=80) example: hline(dashes='*', scrw=90)

import_boundary_definitions(**kwargs)

import_flow_data(*args, **kwargs)

import_g3d_flow_data(*args, **kwargs)

import_mesh(*args, **kwargs)

initialize_block_flow_field(im, f)

initialize_flow_field(f)

initialize_from_conservative(ro, ru, rv, rw, et)

initialize_from_primitive(p, u, v, w, t)

initialize_linear(ql, qr[, direction])

initialize_region_flow_field(r, f)

jobname_append(name)

extends jobname with the specified string input: name example: jobname_append(name)

node_get_block(kp)

node_get_ijk(kp)

plot_field_2D(field[, im, k])

plot_flow_2D([im, k])

plot_probe_array(var, im, i0, j0, k0, idir, ...)

plot_scalar_2D(var[, im, k])

plot_scalars_2D(variables[, im, k])

print()

prints entity data

remove_TVD_limiter(m)

set(*args, **kwargs)

sets code parameters according to specifications input: args, kwargs example: set(args, kwargs)

set_convection_scheme_coefs(c1, c2, c3, c4)

set_damp(fp, fc)

set_from_key_value(key, value)

sets code parameters from specified key => value data input: key, value valid keys for G3DCode base class: 'verbose', 'silent/quiet', 'jobname', 'working_directory', 'dimension', 'cuda', 'prof' example: set_from_key_value(key, value)

set_gas_properties(g, R)

update_BC(boco)

update_BC_family(*args, **kwargs)

update_BC_type(*args, **kwargs)

check_FMP_metrics

diff_flux_check

export_cell_volume

export_inverse_cell_volume

flux_check

ltsp_test

run

step_test
class g3d.flow.Q3DFlow(*args: Any, **kwargs: Any)[source]

Bases: SolverEnv

Attributes:
calculator
return:

dom
return:

solver
return:

tag

tag (string) used for identification

Methods

add_BCMod(*args, **kwargs)

add_TVD_limiter(m)

add_to_nstep(N)

auxvr()

bc_update_conservative(boco)

bc_update_primitive(boco)

bc_update_speed_of_sound(boco)

cell_get_block(kc)

cell_get_ijk(kc)

check_cell_metrics(ic)

copy(e)

copies data from specified entity input: entity example: copy(e)

export_field(field, **kwargs)

export_flow(*args, **kwargs)

export_mesh(*args, **kwargs)

export_scalar(var, **kwargs)

export_scalars(variables, **kwargs)

export_velocity_gradients(*args, **kwargs)

generate_mesh_from_pipe_data(q1d)

get_auxv_array([var])

get_auxv_arrays()

get_block_sizes(im)

get_cell(im, i, j, k)

get_cell_centers()

get_cons_array([var])

get_cons_arrays()

get_gas()

get_gas_properties()

get_n_cells()

get_n_faces()

get_n_ghost_cells()

get_n_ghost_nodes()

get_n_nodes()

get_new_Auxv()

get_new_BoCo(*args, **kwargs)

get_new_Cons()

get_new_Q1DPipe()

get_new_Region()

get_new_matrix()

get_node(im, i, j, k)

get_node_coordinates()

get_post_array([var])

get_post_arrays()

get_residual()

get_shock_capturing_field()

get_streamtube_normal([idx])

get_time()

get_volume([idx])

header(*args, **kwargs)

prints a header with specified information input: info optional input: dashes (default='='), scrw (default=80), number of blank lines after dashes n_space (default=1) example: header(info='header info')

hline(*args, **kwargs)

prints horizontal line optional input (kwargs): dashes (default='-'), scrw (default=80) example: hline(dashes='*', scrw=90)

import_boundary_definitions(**kwargs)

import_flow_data(*args, **kwargs)

import_g3d_flow_data(*args, **kwargs)

import_mesh(*args, **kwargs)

initialize_block_flow_field(im, f)

initialize_flow_field(f)

initialize_from_conservative(ro, ru, rv, rw, et)

initialize_from_primitive(p, u, v, w, t)

initialize_linear(ql, qr[, direction])

initialize_region_flow_field(r, f)

jobname_append(name)

extends jobname with the specified string input: name example: jobname_append(name)

node_get_block(kp)

node_get_ijk(kp)

plot_field_2D(field[, im, k])

plot_flow_2D([im, k])

plot_probe_array(var, im, i0, j0, k0, idir, ...)

plot_scalar_2D(var[, im, k])

plot_scalars_2D(variables[, im, k])

print()

prints entity data

remove_TVD_limiter(m)

set(*args, **kwargs)

sets code parameters according to specifications input: args, kwargs example: set(args, kwargs)

set_convection_scheme_coefs(c1, c2, c3, c4)

set_damp(fp, fc)

set_from_key_value(key, value)

sets code parameters from specified key => value data input: key, value valid keys for G3DCode base class: 'verbose', 'silent/quiet', 'jobname', 'working_directory', 'dimension', 'cuda', 'prof' example: set_from_key_value(key, value)

set_gas_properties(g, R)

update_BC(boco)

update_BC_family(*args, **kwargs)

update_BC_type(*args, **kwargs)

check_FMP_metrics

diff_flux_check

export_cell_volume

export_inverse_cell_volume

flux_check

ltsp_test

run

step_test