g3d.flow.vars package

Submodules

g3d.flow.vars.auxv module

auxiliary variable entity (Auxv class definition)

class g3d.flow.vars.auxv.Auxv(*args: Any, **kwargs: Any)[source]

Bases: G3DEntity

Attributes:
c
return:

p
return:

t
return:

tag

tag (string) used for identification

u
return:

v
return:

w
return:

Methods

copy(auxv)

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

get_Cons(gas)

get_velocity_vector()

print()

prints entity data

set(*args, **kwargs)

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

set_from_conservative(ro, ru, rv, rw, et[, gas])

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)

set_velocity_vector(vel)

uiui()

update(cons[, gas])

update_speed_of_sound([gas])

vel_dot_product(vel)

property c: float

return:

copy(auxv: Auxv) → None[source]

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

get_Cons(gas: Gas) → Cons[source]
Parameters:

gas

Returns:

get_velocity_vector() → ndarray[source]
Returns:

property p: float

return:

print() → None[source]

prints entity data

set_from_conservative(ro: float, ru: float, rv: float, rw: float, et: float, gas: Gas | None = None) → None[source]
Parameters:

  • ro

  • ru

  • rv

  • rw

  • et

  • gas

set_from_key_value(key: str, value: Any) → bool[source]

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)

set_velocity_vector(vel: Tuple[float, float, float] | list[float] | ndarray) → None[source]
Parameters:

vel

property t: float

return:

property u: float

return:

uiui() → float[source]
Returns:

update(cons: Cons, gas: Gas | None = None) → None[source]
Parameters:

  • cons

  • gas

update_speed_of_sound(gas: Gas | None = None) → None[source]
Parameters:

gas

property v: float

return:

vel_dot_product(vel: list[float] | ndarray | Auxv) → float[source]
Parameters:

vel

Returns:

property w: float

return:

g3d.flow.vars.cons module

conservative variable entity (Cons class definition)

class g3d.flow.vars.cons.Cons(*args: Any, **kwargs: Any)[source]

Bases: G3DEntity

Attributes:
et
return:

ro
return:

ru
return:

rv
return:

rw
return:

tag

tag (string) used for identification

Methods

copy(cons)

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

get_momentum_vector()

print()

prints entity data

ruiui()

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)

set_from_primitive(*args)

set_momentum_vector(r_vel)

copy(cons: Cons) → None[source]

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

property et: float

return:

get_momentum_vector() → ndarray[source]
Returns:

print() → None[source]

prints entity data

property ro: float

return:

property ru: float

return:

ruiui() → float[source]
Returns:

property rv: float

return:

property rw: float

return:

set_from_key_value(key: str, value: Any) → bool[source]

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)

set_from_primitive(*args: Any) → None[source]
Parameters:

args

set_momentum_vector(r_vel: Tuple[float, float, float] | list[float] | ndarray) → None[source]
Parameters:

r_vel

g3d.flow.vars.post module

postprocessing variable entity (Post class definition)

class g3d.flow.vars.post.Post(*args: Any, **kwargs: Any)[source]

Bases: G3DEntity

Attributes:
M
return:

p0
return:

s
return:

t0
return:

tag

tag (string) used for identification

Methods

copy(post)

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

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)

update(cons, auxv, gas)

property M: float

return:

copy(post: Post) → None[source]

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

property p0: float

return:

print() → None[source]

prints entity data

property s: float

return:

set_from_key_value(key: str, value: Any) → bool[source]

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)

property t0: float

return:

update(cons: Cons, auxv: Auxv, gas: Gas) → None[source]
Parameters:

  • cons

  • auxv

  • gas

g3d.flow.vars.turb module

turbulence model variable entity (Turb class definition)

class g3d.flow.vars.turb.Turb(*args: Any, **kwargs: Any)[source]

Bases: G3DEntity

Attributes:
tag

tag (string) used for identification

visct
return:

Methods

copy(turb)

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

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)

update(auxv, gas)

copy(turb: Turb) → None[source]

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

print() → None[source]

prints entity data

set_from_key_value(key: str, value: Any) → bool[source]

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)

update(auxv: Auxv, gas: Gas)[source]
Parameters:

  • auxv

  • gas

property visct: float

return:

g3d.flow.vars.vgrad module

velocity gradient variable entity (VGrad class definition)

class g3d.flow.vars.vgrad.VGrad(*args: Any, **kwargs: Any)[source]

Bases: G3DEntity

Attributes:
dd
return:

dudx
return:

dudy
return:

dudz
return:

dvdx
return:

dvdy
return:

dvdz
return:

dwdx
return:

dwdy
return:

dwdz
return:

tag

tag (string) used for identification

Methods

SijSij()

copy(vgrad)

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

divergence()

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)

vorticity()

vorticity_magnitude()

SijSij() → float[source]
Returns:

copy(vgrad: VGrad) → None[source]

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

property dd: ndarray

return:

divergence() → float[source]
Returns:

property dudx: float

return:

property dudy: float

return:

property dudz: float

return:

property dvdx: float

return:

property dvdy: float

return:

property dvdz: float

return:

property dwdx: float

return:

property dwdy: float

return:

property dwdz: float

return:

print() → None[source]

prints entity data

set_from_key_value(key: str, value: Any) → bool[source]

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)

vorticity() → ndarray[source]
Returns:

vorticity_magnitude() → float[source]
Returns:

Module contents

g3d/flow/solver/vars sub library

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

Bases: G3DEntity

Attributes:
c
return:

p
return:

t
return:

tag

tag (string) used for identification

u
return:

v
return:

w
return:

Methods

copy(auxv)

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

get_Cons(gas)

get_velocity_vector()

print()

prints entity data

set(*args, **kwargs)

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

set_from_conservative(ro, ru, rv, rw, et[, gas])

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)

set_velocity_vector(vel)

uiui()

update(cons[, gas])

update_speed_of_sound([gas])

vel_dot_product(vel)

property c: float

return:

copy(auxv: Auxv) → None[source]

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

get_Cons(gas: Gas) → Cons[source]
Parameters:

gas

Returns:

get_velocity_vector() → ndarray[source]
Returns:

property p: float

return:

print() → None[source]

prints entity data

set_from_conservative(ro: float, ru: float, rv: float, rw: float, et: float, gas: Gas | None = None) → None[source]
Parameters:

  • ro

  • ru

  • rv

  • rw

  • et

  • gas

set_from_key_value(key: str, value: Any) → bool[source]

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)

set_velocity_vector(vel: Tuple[float, float, float] | list[float] | ndarray) → None[source]
Parameters:

vel

property t: float

return:

property u: float

return:

uiui() → float[source]
Returns:

update(cons: Cons, gas: Gas | None = None) → None[source]
Parameters:

  • cons

  • gas

update_speed_of_sound(gas: Gas | None = None) → None[source]
Parameters:

gas

property v: float

return:

vel_dot_product(vel: list[float] | ndarray | Auxv) → float[source]
Parameters:

vel

Returns:

property w: float

return:

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

Bases: G3DEntity

Attributes:
et
return:

ro
return:

ru
return:

rv
return:

rw
return:

tag

tag (string) used for identification

Methods

copy(cons)

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

get_momentum_vector()

print()

prints entity data

ruiui()

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)

set_from_primitive(*args)

set_momentum_vector(r_vel)

copy(cons: Cons) → None[source]

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

property et: float

return:

get_momentum_vector() → ndarray[source]
Returns:

print() → None[source]

prints entity data

property ro: float

return:

property ru: float

return:

ruiui() → float[source]
Returns:

property rv: float

return:

property rw: float

return:

set_from_key_value(key: str, value: Any) → bool[source]

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)

set_from_primitive(*args: Any) → None[source]
Parameters:

args

set_momentum_vector(r_vel: Tuple[float, float, float] | list[float] | ndarray) → None[source]
Parameters:

r_vel

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

Bases: G3DEntity

Attributes:
M
return:

p0
return:

s
return:

t0
return:

tag

tag (string) used for identification

Methods

copy(post)

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

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)

update(cons, auxv, gas)

property M: float

return:

copy(post: Post) → None[source]

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

property p0: float

return:

print() → None[source]

prints entity data

property s: float

return:

set_from_key_value(key: str, value: Any) → bool[source]

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)

property t0: float

return:

update(cons: Cons, auxv: Auxv, gas: Gas) → None[source]
Parameters:

  • cons

  • auxv

  • gas

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

Bases: G3DEntity

Attributes:
tag

tag (string) used for identification

visct
return:

Methods

copy(turb)

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

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)

update(auxv, gas)

copy(turb: Turb) → None[source]

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

print() → None[source]

prints entity data

set_from_key_value(key: str, value: Any) → bool[source]

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)

update(auxv: Auxv, gas: Gas)[source]
Parameters:

  • auxv

  • gas

property visct: float

return:

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

Bases: G3DEntity

Attributes:
dd
return:

dudx
return:

dudy
return:

dudz
return:

dvdx
return:

dvdy
return:

dvdz
return:

dwdx
return:

dwdy
return:

dwdz
return:

tag

tag (string) used for identification

Methods

SijSij()

copy(vgrad)

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

divergence()

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)

vorticity()

vorticity_magnitude()

SijSij() → float[source]
Returns:

copy(vgrad: VGrad) → None[source]

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

property dd: ndarray

return:

divergence() → float[source]
Returns:

property dudx: float

return:

property dudy: float

return:

property dudz: float

return:

property dvdx: float

return:

property dvdy: float

return:

property dvdz: float

return:

property dwdx: float

return:

property dwdy: float

return:

property dwdz: float

return:

print() → None[source]

prints entity data

set_from_key_value(key: str, value: Any) → bool[source]

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)

vorticity() → ndarray[source]
Returns:

vorticity_magnitude() → float[source]
Returns: