g3d.flow.solver.step package

Submodules

g3d.flow.solver.step.backward_euler module

BackwardEuler class definition (extends DualTimeStepper)

class g3d.flow.solver.step.backward_euler.BackwardEuler(*args: Any, **kwargs: Any)[source]

Bases: DualTimeStepper

BackwardEuler class definition

Attributes:
tag

tag (string) used for identification

Methods

associate(dom)

copy(e)

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

get_shock_capturing_field()

print()

prints entity data

set(*args, **kwargs)

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

set_from_key_value(key, value)

sets entity parameters from specified key => value data input: key, value valid keys for G3DCode base class: 'tag' example: set_from_key_value(key, value)

change_eqn_mode

diff_flux_check

flux_check

flux_test

fwd

initialize

ltsp_test

setup_and_allocate

g3d.flow.solver.step.crank_nicolson module

class g3d.flow.solver.step.crank_nicolson.CrankNicolson(*args: Any, **kwargs: Any)[source]

Bases: DualTimeStepper

Attributes:
tag

tag (string) used for identification

Methods

associate(dom)

copy(e)

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

get_shock_capturing_field()

print()

prints entity data

set(*args, **kwargs)

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

set_from_key_value(key, value)

sets entity parameters from specified key => value data input: key, value valid keys for G3DCode base class: 'tag' example: set_from_key_value(key, value)

change_eqn_mode

diff_flux_check

flux_check

flux_test

fwd

initialize

ltsp_test

setup_and_allocate

g3d.flow.solver.step.dual_time_stepper module

class g3d.flow.solver.step.dual_time_stepper.DualTimeStepper(*args: Any, **kwargs: Any)[source]

Bases: G3DStep

Attributes:
tag

tag (string) used for identification

Methods

associate(dom)

copy(e)

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

get_shock_capturing_field()

print()

prints entity data

set(*args, **kwargs)

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

set_from_key_value(key, value)

sets entity parameters from specified key => value data input: key, value valid keys for G3DCode base class: 'tag' example: set_from_key_value(key, value)

change_eqn_mode

diff_flux_check

flux_check

flux_test

fwd

initialize

ltsp_test

setup_and_allocate
associate(dom: Domain) → None[source]
Parameters:

dom

fwd() → None[source]

g3d.flow.solver.step.runge_kutta module

class g3d.flow.solver.step.runge_kutta.RungeKutta(*args: Any, **kwargs: Any)[source]

Bases: G3DStep

Attributes:
tag

tag (string) used for identification

Methods

associate(dom)

copy(e)

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

get_shock_capturing_field()

print()

prints entity data

set(*args, **kwargs)

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

set_from_key_value(key, value)

sets entity parameters from specified key => value data input: key, value valid keys for G3DCode base class: 'tag' example: set_from_key_value(key, value)

change_eqn_mode

diff_flux_check

flux_check

flux_test

fwd

initialize

ltsp_test

setup_and_allocate
fwd() → None[source]

g3d.flow.solver.step.step module

class g3d.flow.solver.step.step.G3DStep(*args: Any, **kwargs: Any)[source]

Bases: G3DEntity

Attributes:
tag

tag (string) used for identification

Methods

associate(dom)

copy(e)

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

get_shock_capturing_field()

print()

prints entity data

set(*args, **kwargs)

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

set_from_key_value(key, value)

sets entity parameters from specified key => value data input: key, value valid keys for G3DCode base class: 'tag' example: set_from_key_value(key, value)

change_eqn_mode

diff_flux_check

flux_check

flux_test

fwd

initialize

ltsp_test

setup_and_allocate
associate(dom: Domain) → None[source]
Parameters:

dom

change_eqn_mode() → None[source]
diff_flux_check() → None[source]
flux_check() → None[source]
flux_test() → None[source]
fwd() → None[source]
get_shock_capturing_field() → ndarray[source]
Returns:

initialize() → None[source]
ltsp_test() → None[source]
setup_and_allocate() → None[source]

Module contents

g3d/flow/solver/step sub library

class g3d.flow.solver.step.BackwardEuler(*args: Any, **kwargs: Any)[source]

Bases: DualTimeStepper

BackwardEuler class definition

Attributes:
tag

tag (string) used for identification

Methods

associate(dom)

copy(e)

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

get_shock_capturing_field()

print()

prints entity data

set(*args, **kwargs)

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

set_from_key_value(key, value)

sets entity parameters from specified key => value data input: key, value valid keys for G3DCode base class: 'tag' example: set_from_key_value(key, value)

change_eqn_mode

diff_flux_check

flux_check

flux_test

fwd

initialize

ltsp_test

setup_and_allocate
class g3d.flow.solver.step.CrankNicolson(*args: Any, **kwargs: Any)[source]

Bases: DualTimeStepper

Attributes:
tag

tag (string) used for identification

Methods

associate(dom)

copy(e)

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

get_shock_capturing_field()

print()

prints entity data

set(*args, **kwargs)

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

set_from_key_value(key, value)

sets entity parameters from specified key => value data input: key, value valid keys for G3DCode base class: 'tag' example: set_from_key_value(key, value)

change_eqn_mode

diff_flux_check

flux_check

flux_test

fwd

initialize

ltsp_test

setup_and_allocate
class g3d.flow.solver.step.DualTimeStepper(*args: Any, **kwargs: Any)[source]

Bases: G3DStep

Attributes:
tag

tag (string) used for identification

Methods

associate(dom)

copy(e)

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

get_shock_capturing_field()

print()

prints entity data

set(*args, **kwargs)

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

set_from_key_value(key, value)

sets entity parameters from specified key => value data input: key, value valid keys for G3DCode base class: 'tag' example: set_from_key_value(key, value)

change_eqn_mode

diff_flux_check

flux_check

flux_test

fwd

initialize

ltsp_test

setup_and_allocate
associate(dom: Domain) → None[source]
Parameters:

dom

fwd() → None[source]
class g3d.flow.solver.step.G3DStep(*args: Any, **kwargs: Any)[source]

Bases: G3DEntity

Attributes:
tag

tag (string) used for identification

Methods

associate(dom)

copy(e)

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

get_shock_capturing_field()

print()

prints entity data

set(*args, **kwargs)

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

set_from_key_value(key, value)

sets entity parameters from specified key => value data input: key, value valid keys for G3DCode base class: 'tag' example: set_from_key_value(key, value)

change_eqn_mode

diff_flux_check

flux_check

flux_test

fwd

initialize

ltsp_test

setup_and_allocate
associate(dom: Domain) → None[source]
Parameters:

dom

change_eqn_mode() → None[source]
diff_flux_check() → None[source]
flux_check() → None[source]
flux_test() → None[source]
fwd() → None[source]
get_shock_capturing_field() → ndarray[source]
Returns:

initialize() → None[source]
ltsp_test() → None[source]
setup_and_allocate() → None[source]
class g3d.flow.solver.step.RungeKutta(*args: Any, **kwargs: Any)[source]

Bases: G3DStep

Attributes:
tag

tag (string) used for identification

Methods

associate(dom)

copy(e)

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

get_shock_capturing_field()

print()

prints entity data

set(*args, **kwargs)

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

set_from_key_value(key, value)

sets entity parameters from specified key => value data input: key, value valid keys for G3DCode base class: 'tag' example: set_from_key_value(key, value)

change_eqn_mode

diff_flux_check

flux_check

flux_test

fwd

initialize

ltsp_test

setup_and_allocate
fwd() → None[source]