Skip to content

Commit eeb9dbb

Browse files
committed
Update run command
1 parent 4c9332f commit eeb9dbb

9 files changed

+22
-22
lines changed

docs/getting_started.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -23,13 +23,13 @@ Problems are solved by running the ``NSfracStepMove.py`` script, or by using the
2323
problem `DrivenCavity.py`, you can run the following command:
2424

2525
``` console
26-
$ oasism NSfracStepMove
26+
$ oasismove NSfracStepMove
2727
```
2828

2929
To specify a specific problem, you can run the following command:
3030

3131
``` console
32-
$ oasism NSfracStepMove problem=DrivenCavity
32+
$ oasismove NSfracStepMove problem=DrivenCavity
3333
```
3434

3535
```{note}

docs/interpolation.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -16,14 +16,14 @@ problem. By default, the problem runs for $T=10$ using $\mathbb{P_1}$ elements,
1616
argument `velocity_degree=1`. Assume we have run the problem using the default parameters:
1717

1818
``` console
19-
$ oasism NSfracStep solver=IPCS_ABCN problem=DrivenCavity
19+
$ oasismove NSfracStep solver=IPCS_ABCN problem=DrivenCavity
2020
```
2121

2222
To restart and continue the simulation until $T=20$ using $\mathbb{P_2}$ elements, we may simply pass
2323
the `velocity_degree=2` argument, in addition to the required parameters for restarting a simulation:
2424

2525
``` console
26-
$ oasism NSfracStep solver=IPCS_ABCN problem=DrivenCavity velocity_degree=2 restart_folder=results_driven_cavity/data/1/Checkpoint T=20
26+
$ oasismove NSfracStep solver=IPCS_ABCN problem=DrivenCavity velocity_degree=2 restart_folder=results_driven_cavity/data/1/Checkpoint T=20
2727
```
2828

2929
Note that the ability to interpolate to a higher function space can be computation-intensive, especially for large

docs/movingcylinder.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -58,13 +58,13 @@ To run the oscillating cylinder problem for $T=5$ seconds with default parameter
5858
command:
5959

6060
``` console
61-
$ oasism NSfracStepMove problem=MovingCylinder Re=500 u_inf=1.0 F=1.0 T=5 mesh_path=src/oasismove/mesh/cylinder.xdmf
61+
$ oasismove NSfracStepMove problem=MovingCylinder Re=500 u_inf=1.0 F=1.0 T=5 mesh_path=src/oasismove/mesh/cylinder.xdmf
6262
```
6363

6464
or without explicitly writing the default parameters:
6565

6666
``` console
67-
$ oasism NSfracStepMove problem=MovingCylinder mesh_path=src/oasismove/mesh/cylinder.xdmf
67+
$ oasismove NSfracStepMove problem=MovingCylinder mesh_path=src/oasismove/mesh/cylinder.xdmf
6868
```
6969

7070
and the simulation will start. The default time step is relatively small, so the simulation might take some minutes
@@ -108,7 +108,7 @@ adjusted by adding it as a command line argument. For instance, we can run a sim
108108
following command:
109109

110110
``` console
111-
$ oasism NSfracStepMove problem=MovingCylinder Re=100 mesh_path=src/oasismove/mesh/cylinder.xdmf
111+
$ oasismove NSfracStepMove problem=MovingCylinder Re=100 mesh_path=src/oasismove/mesh/cylinder.xdmf
112112
```
113113

114114
As an example of adjusting the Reynolds number, we have run the simulation using $Re=1, 20, 100,$ and $500$. In

docs/movingtg.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,7 @@ the box mesh. By default, the Reynolds number is set to Re = $1/\nu=1600$.
5151
To simulate this flow problem in OasisMove using the default parameters, run the following command:
5252

5353
``` console
54-
$ oasism NSfracStepMove problem=MovingTaylorGreen3D
54+
$ oasismove NSfracStepMove problem=MovingTaylorGreen3D
5555
```
5656

5757
and the simulation will start. Since this problem is in three dimensions, there will be an additional set of equations
@@ -61,7 +61,7 @@ OasisMove supports. Thus, to decrease the computational time by utilizing high p
6161
of OasisMove, can run the following command:
6262

6363
``` console
64-
$ mpirun -np 16 oasism NSfracStepMove problem=MovingTaylorGreen3D
64+
$ mpirun -np 16 oasismove NSfracStepMove problem=MovingTaylorGreen3D
6565
```
6666

6767
## Results
@@ -95,7 +95,7 @@ parameters as command-line arguments to change their value. For instance, to cre
9595
we can run the following command:
9696

9797
``` console
98-
$ oasism NSfracStepMove problem=MovingTaylorGreen3D Nx=50 Ny=50 Nz=50
98+
$ oasismove NSfracStepMove problem=MovingTaylorGreen3D Nx=50 Ny=50 Nz=50
9999
```
100100

101101
## References

docs/movingvortex.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ length of the mesh motion, $T$ is the length of one cycle, and $L=1$.
3939
To simulate this flow problem in OasisMove using the default parameters you can run the following command:
4040

4141
``` console
42-
$ oasism NSfracStepMove problem=MovingVortex
42+
$ oasismove NSfracStepMove problem=MovingVortex
4343
```
4444

4545
and the simulation will start. The simulation should only take a couple of seconds when running with the default
@@ -69,15 +69,15 @@ parameters as command-line arguments to change their value. For instance, to cre
6969
can run the following command:
7070

7171
``` console
72-
$ oasism NSfracStepMove problem=MovingVortex Nx=100 Ny=100
72+
$ oasismove NSfracStepMove problem=MovingVortex Nx=100 Ny=100
7373
```
7474

7575
Similarly, we can adjust the number of time steps the simulation should perform by adjusting the time step
7676
parameter `dt`, which by default is $\Delta t = 5\cdot 10^{-2}$. To simulate 1000 time steps between $t=0$ and $t=T=1$,
7777
we can run the following command:
7878

7979
``` console
80-
$ oasism NSfracStepMove problem=MovingVortex T=1 dt=0.001
80+
$ oasismove NSfracStepMove problem=MovingVortex T=1 dt=0.001
8181
```
8282

8383
```{important}

docs/movingwall.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ To run the wall-driven channel flow problem for $T=1$ seconds with the default p
3636
following command:
3737

3838
``` console
39-
$ oasism NSfracStepMove problem=MovingWall
39+
$ oasismove NSfracStepMove problem=MovingWall
4040
```
4141

4242
and the simulation will start. The default time step size is set to $\Delta t=0.005$, thus a full simulation performs

docs/restart.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ problem. For this problem, the default values are $T=10$, a time step of $\Delta
1818
time step (`checkpoint=500`). Assume we have run the problem using the following command:
1919

2020
``` console
21-
$ oasism NSfracStep solver=IPCS_ABCN problem=DrivenCavity
21+
$ oasismove NSfracStep solver=IPCS_ABCN problem=DrivenCavity
2222
```
2323

2424
After 500 time steps, or when the simulation is finished, there will be located a `Checkpoint` folder within
@@ -33,7 +33,7 @@ prematurely, we may restart the simulation by adding the `restart_folder` param
3333
the `Checkpoint` folder:
3434

3535
``` console
36-
$ oasism NSfracStep solver=IPCS_ABCN problem=DrivenCavity restart_folder=results_driven_cavity/data/1/Checkpoint
36+
$ oasismove NSfracStep solver=IPCS_ABCN problem=DrivenCavity restart_folder=results_driven_cavity/data/1/Checkpoint
3737
```
3838

3939
The simulation should now restart at the latest checkpoint, and continue as normal until $T=10.
@@ -46,7 +46,7 @@ to the `Checkpoint` folder, and a new end-time ($T$) for the simulation. With a
4646
the `DrivenCavity` problem and continue running it until $T=20$ with the following command:
4747

4848
``` console
49-
$ oasism NSfracStep solver=IPCS_ABCN problem=DrivenCavity T=20 restart_folder=results_driven_cavity/data/1/Checkpoint
49+
$ oasismove NSfracStep solver=IPCS_ABCN problem=DrivenCavity T=20 restart_folder=results_driven_cavity/data/1/Checkpoint
5050
```
5151

5252
The simulation should now restart at $T=10$, and continue running until $T=20$.

docs/stenosis.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -72,7 +72,7 @@ boundary ID is 3, backflow stabilization can be added to the outlet with a stren
7272
command:
7373

7474
``` console
75-
$ oasism NSfracStep solver=IPCS_ABCN problem=Stenosis backflow_facets="[3]" backflow_beta=0.2
75+
$ oasismove NSfracStep solver=IPCS_ABCN problem=Stenosis backflow_facets="[3]" backflow_beta=0.2
7676
```
7777

7878
Note that the list of boundaries has to be encapsulated by quotation marks, or the IDs can be manually set
@@ -86,22 +86,22 @@ To run the stenosis problem for $T=15$ with default parameters in OasisMove, whi
8686
stabilization at the outlet, you can run the following command:
8787

8888
``` console
89-
$ oasism NSfracStep solver=IPCS_ABCN problem=Stenosis
89+
$ oasismove NSfracStep solver=IPCS_ABCN problem=Stenosis
9090
```
9191

9292
where we specify the `NSfracStep` module and `IPCS_ABCN` solver because the problem is not moving. Alternatively we can
9393
pass the `dynamic_mesh=False` flag for rigid domain problems, telling the default solver (`IPCS_ABCN_Move`) to skip
9494
solving the mesh equations:
9595

9696
``` console
97-
$ oasism NSfracStepMove problem=Stenosis dynamic_mesh=False
97+
$ oasismove NSfracStepMove problem=Stenosis dynamic_mesh=False
9898
```
9999

100100
The default time step is set to $T=15$ and might take some minutes to complete, depending on your hardware.
101101
Alternatively, you can solve the problem in parallel to speed up the simulation time:
102102

103103
``` console
104-
$ mpirun -np 8 oasism NSfracStepMove problem=Stenosis dynamic_mesh=False
104+
$ mpirun -np 8 oasismove NSfracStepMove problem=Stenosis dynamic_mesh=False
105105
```
106106

107107
## Results

pyproject.toml

+1-1
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ license = { file = "LICENSE" }
1010
readme = "README.md"
1111

1212
[project.scripts]
13-
oasism = "oasismove.run_oasis:main"
13+
oasismove = "oasismove.run_oasis:main"
1414

1515
[project.optional-dependencies]
1616
test = [

0 commit comments

Comments
 (0)