Skip to content

Commit

Permalink
Merge pull request #25 from aurora-multiphysics/documentation-improve…
Browse files Browse the repository at this point in the history
…ment

Documentation improvement
  • Loading branch information
lukethehuman authored Oct 18, 2023
2 parents e0cfedd + 758628b commit 53ef9dc
Show file tree
Hide file tree
Showing 7 changed files with 37 additions and 7 deletions.
18 changes: 17 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -49,8 +49,24 @@ as follows:
./proteus-opt -i <input-file>.i
```

Building Using Multiple Cores
-----------------------------

The install process above can be sped up
by using multiple cores during the build process.
Note that this will also need more memory
and to ensure the build goes smoothly,
we recommend having at least 4GB per core.
Multiple cores are enabled
by setting the MOOSE JOBS environment variable
before running the install script:
```
export MOOSE_JOBS=4
```
Where the number 4 in the example above corresponds to using four cores.

Docker
-----
------

Proteus can be run in a container to make installation easier.

Expand Down
5 changes: 3 additions & 2 deletions examples/fluids/duct3D_ke.i
Original file line number Diff line number Diff line change
Expand Up @@ -185,8 +185,9 @@
[Executioner]
type = Steady
solve_type = NEWTON
petsc_options_iname = '-pc_type -pc_hypre_type'
petsc_options_value = 'hypre euclid'
petsc_options_iname = '-pc_type'
petsc_options_value = 'ilu'
l_max_its = 30
[]

[Outputs]
Expand Down
4 changes: 2 additions & 2 deletions examples/fluids/duct3D_laminar_AD.i
Original file line number Diff line number Diff line change
Expand Up @@ -103,8 +103,8 @@
[Executioner]
type = Steady
solve_type = NEWTON
petsc_options_iname = '-pc_type -pc_hypre_type'
petsc_options_value = 'hypre euclid'
petsc_options_iname = '-pc_type'
petsc_options_value = 'ilu'
l_max_its = 30
automatic_scaling = true
[]
Expand Down
5 changes: 3 additions & 2 deletions examples/fluids/duct3D_laminar_nonAD.i
Original file line number Diff line number Diff line change
Expand Up @@ -127,9 +127,10 @@
[Executioner]
type = Steady
solve_type = NEWTON
petsc_options_iname = '-pc_type -pc_hypre_type'
petsc_options_value = 'hypre euclid'
petsc_options_iname = '-pc_type'
petsc_options_value = 'ilu'
l_max_its = 30
automatic_scaling = true
[]

[Outputs]
Expand Down
4 changes: 4 additions & 0 deletions scripts/install_csd3.sh
Original file line number Diff line number Diff line change
Expand Up @@ -49,6 +49,10 @@ CC=$CC CXX=$CXX F90=$F90 F77=$F77 FC=$FC \

METHODS="opt" ./scripts/update_and_rebuild_libmesh.sh --with-mpi

# Build WASP

./scripts/update_and_rebuild_wasp.sh

# Configure AD
# Derivative size should be the total of
# 8 for each first order variable
Expand Down
4 changes: 4 additions & 0 deletions scripts/install_fedora.sh
Original file line number Diff line number Diff line change
Expand Up @@ -51,6 +51,10 @@ CC=$CC CXX=$CXX F90=$F90 F77=$F77 FC=$FC \

METHODS="opt" ./scripts/update_and_rebuild_libmesh.sh --with-mpi

# Build WASP

./scripts/update_and_rebuild_wasp.sh

# Configure AD
# Derivative size should be the total of
# 8 for each first order variable
Expand Down
4 changes: 4 additions & 0 deletions scripts/install_ubuntu.sh
Original file line number Diff line number Diff line change
Expand Up @@ -48,6 +48,10 @@ CC=$CC CXX=$CXX F90=$F90 F77=$F77 FC=$FC \

METHODS="opt" ./scripts/update_and_rebuild_libmesh.sh --with-mpi

# Build WASP

./scripts/update_and_rebuild_wasp.sh

# Configure AD
# Derivative size should be the total of
# 8 for each first order variable
Expand Down

0 comments on commit 53ef9dc

Please sign in to comment.