FluidGym
Installation
Basic Usage
Interfaces
FluidGym
Gymnasium
TorchRL
Pettingzoo
Stable-Baselines3
Gradient-Based Methods
Wrappers
FlattenObservation Wrapper
ObsExtraction Wrapper
ActionNoise Wrapper
SensorNoise Wrapper
Rendering Environments
Advanced Usage
Running FluidGym on multiple GPUs in parallel
Adding Custom Environments to FluidGym
Additional Configuration Options
API Reference
FluidGym Environments
FluidEnv
FluidGym Wrappers
FlattenObservation
ObsExtraction
ActionNoise
SensorNoise
Flow Past Cylinder
CylinderJetEnv2D
CylinderRotEnv2D
CylinderJetEnv3D
Rayleigh-Bénard Convection (RBC)
RBCEnv2D
RBCEnv3D
Flow Past Airfoil
AirfoilEnv2D
AirfoilEnv3D
Turbulent Channel Flow (TCF)
TCF3DBottomEnv
TCF3DBothEnv
Glossary
Frequently Asked Questions
FluidGym
Index
Edit on GitHub
Index
A
|
C
|
D
|
E
|
F
|
G
|
I
|
L
|
M
|
N
|
O
|
P
|
R
|
S
|
T
|
U
|
V
A
action_space (fluidgym.envs.fluid_env.FluidEnv property)
ActionNoise (class in fluidgym.wrappers.action_noise)
AFC
AirfoilEnv2D (class in fluidgym.envs.airfoil)
AirfoilEnv3D (class in fluidgym.envs.airfoil)
C
cuda_device (fluidgym.envs.fluid_env.FluidEnv property)
CylinderJetEnv2D (class in fluidgym.envs.cylinder)
CylinderJetEnv3D (class in fluidgym.envs.cylinder)
CylinderRotEnv2D (class in fluidgym.envs.cylinder)
D
detach() (fluidgym.envs.fluid_env.FluidEnv method)
differentiable (fluidgym.envs.fluid_env.FluidEnv property)
dt (fluidgym.envs.fluid_env.FluidEnv property)
E
episode_length (fluidgym.envs.fluid_env.FluidEnv property)
F
FlattenObservation (class in fluidgym.wrappers.flatten_obs)
FluidEnv (class in fluidgym.envs.fluid_env)
G
get_pressure() (fluidgym.envs.fluid_env.FluidEnv method)
get_state() (fluidgym.envs.fluid_env.FluidEnv method)
get_uncontrolled_episode_metrics() (fluidgym.envs.fluid_env.FluidEnv method)
get_velocity() (fluidgym.envs.fluid_env.FluidEnv method)
get_vorticity() (fluidgym.envs.fluid_env.FluidEnv method)
I
id (fluidgym.envs.cylinder.CylinderJetEnv2D property)
(fluidgym.envs.cylinder.CylinderJetEnv3D property)
(fluidgym.envs.cylinder.CylinderRotEnv2D property)
(fluidgym.envs.fluid_env.FluidEnv property)
(fluidgym.envs.tcf.TCF3DBottomEnv property)
init() (fluidgym.envs.fluid_env.FluidEnv method)
initial_domain_id (fluidgym.envs.fluid_env.FluidEnv property)
(fluidgym.envs.tcf.TCF3DBottomEnv property)
L
load_initial_domain() (fluidgym.envs.fluid_env.FluidEnv method)
load_opposition_control_episode() (fluidgym.envs.tcf.TCF3DBottomEnv method)
M
MARL
metadata (fluidgym.envs.fluid_env.FluidEnv attribute)
metrics (fluidgym.envs.fluid_env.FluidEnv property)
mode (fluidgym.envs.fluid_env.FluidEnv property)
N
n_agents (fluidgym.envs.airfoil.AirfoilEnv2D property)
(fluidgym.envs.airfoil.AirfoilEnv3D property)
(fluidgym.envs.cylinder.CylinderJetEnv3D property)
(fluidgym.envs.fluid_env.FluidEnv property)
(fluidgym.envs.tcf.TCF3DBothEnv property)
(fluidgym.envs.tcf.TCF3DBottomEnv property)
n_sim_steps (fluidgym.envs.fluid_env.FluidEnv property)
ndims (fluidgym.envs.fluid_env.FluidEnv property)
O
observation_space (fluidgym.envs.fluid_env.FluidEnv property)
(fluidgym.wrappers.flatten_obs.FlattenObservation property)
(fluidgym.wrappers.obs_extraction.ObsExtraction property)
ObsExtraction (class in fluidgym.wrappers.obs_extraction)
P
plot() (fluidgym.envs.fluid_env.FluidEnv method)
(fluidgym.envs.rbc.RBCEnv3D method)
(fluidgym.envs.tcf.TCF3DBottomEnv method)
plot_actuation() (fluidgym.envs.rbc.RBCEnv2D method)
(fluidgym.envs.rbc.RBCEnv3D method)
plot_grid() (fluidgym.envs.fluid_env.FluidEnv method)
PPO
R
RBC
RBCEnv2D (class in fluidgym.envs.rbc)
RBCEnv3D (class in fluidgym.envs.rbc)
render() (fluidgym.envs.fluid_env.FluidEnv method)
render_shape (fluidgym.envs.fluid_env.FluidEnv property)
(fluidgym.envs.rbc.RBCEnv2D property)
(fluidgym.envs.rbc.RBCEnv3D property)
(fluidgym.envs.tcf.TCF3DBottomEnv property)
reset() (fluidgym.envs.fluid_env.FluidEnv method)
(fluidgym.wrappers.flatten_obs.FlattenObservation method)
(fluidgym.wrappers.obs_extraction.ObsExtraction method)
(fluidgym.wrappers.sensor_noise.SensorNoise method)
RL
S
SAC
sample_action() (fluidgym.envs.fluid_env.FluidEnv method)
SARL
save_gif() (fluidgym.envs.fluid_env.FluidEnv method)
save_opposition_control_episode() (fluidgym.envs.tcf.TCF3DBottomEnv method)
SB3
scale_actions (fluidgym.envs.tcf.TCF3DBottomEnv property)
seed() (fluidgym.envs.fluid_env.FluidEnv method)
SensorNoise (class in fluidgym.wrappers.sensor_noise)
set_state() (fluidgym.envs.fluid_env.FluidEnv method)
step() (fluidgym.envs.fluid_env.FluidEnv method)
(fluidgym.wrappers.action_noise.ActionNoise method)
(fluidgym.wrappers.flatten_obs.FlattenObservation method)
(fluidgym.wrappers.obs_extraction.ObsExtraction method)
(fluidgym.wrappers.sensor_noise.SensorNoise method)
step_length (fluidgym.envs.fluid_env.FluidEnv property)
T
tau_ref (fluidgym.envs.tcf.TCF3DBothEnv property)
(fluidgym.envs.tcf.TCF3DBottomEnv property)
TCF
TCF3DBothEnv (class in fluidgym.envs.tcf)
TCF3DBottomEnv (class in fluidgym.envs.tcf)
test() (fluidgym.envs.fluid_env.FluidEnv method)
time_passed (fluidgym.envs.fluid_env.FluidEnv property)
train() (fluidgym.envs.fluid_env.FluidEnv method)
U
use_marl (fluidgym.envs.fluid_env.FluidEnv property)
V
val() (fluidgym.envs.fluid_env.FluidEnv method)