Skip to content

Commit

Permalink
Rename Lethe applications (chaos-polymtl#882)
Browse files Browse the repository at this point in the history
Description of the problem
The name of the applications in Lethe did not follow any standard format.

Description of the solution
All the applications were renamed according to what was discussed in the group. All the solvers related to fluids start now with lethe-fluid, the DEM solver was renamed as lethe-particles, the coupling of CFD and DEM lethe-fluid-particles, and all rpt applications start now with lethe-rpt.

How Has This Been Tested?
All tests pass since only the name of the folder and the executable was updated.

Documentation
All the examples were updated since the solver used is always mentioned in the ''Features" section. Also, all the commands to run the examples in the "Running the Simulation" section were updated accordingly.

A new file was added to the documentation: doc/source/applications.rst. It adds a table with all the available applications and a brief description of each of them. @blaisb will complete/modify the description of the applications in this PR.

Comments
This PR only changes the name of executable and it does not change the name of any class, .cc or .h file.


Co-authored-by: Bruno Blais <[email protected]>
  • Loading branch information
lpsaavedra and blaisb authored Sep 19, 2023
1 parent 0fbad8d commit 337c93d
Show file tree
Hide file tree
Showing 744 changed files with 393 additions and 353 deletions.
32 changes: 32 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
# Change Log
All notable changes to the Lethe project will be documented in this file.

The format is based on [Keep a Changelog](http://keepachangelog.com/).

## [Master] - 2023-09-19

### Changed

- MAJOR All the applications were renamed [#882](https://github.com/lethe-cfd/lethe/pull/882): `gls_navier_stokes` is now `lethe-fluid`, `gd_navier_stokes` is now `lethe-fluid-block`, `nitsche_navier_stokes` is now `lethe-fluid-nitsche`, `gls_sharp_navier_stokes` is now `lethe-fluid-sharp`, `gls_vans` is now `lethe-fluid-vans`, `mf_navier_stokes` is now `lethe-fluid-matrix-free`, `dem` is now `lethe-particles`, `cfd_dem_coupling` is now `lethe-fluid-particles`, `rpt3d` is now `lethe-rpt-3d`, `rpt_cell_reconstruction_3d` is now `lethe-rpt-cell-reconstruction-3d`, `rpt_fem_reconstruction_3d` is now `lethe-rpt-fem-reconstruction-3d`, and `rpt_l2_projection_3d` is now `lethe-rpt-l2-projection-3d`.

## [Sample] - YYYY/MM/DD

### Added

- MAJOR/MINOR/PATCH Description (#PR).

### Changed

- MAJOR/MINOR/PATCH Description (#PR).

### Deprecated

- MAJOR/MINOR/PATCH Description (#PR).

### Removed

- MAJOR/MINOR/PATCH Description (#PR).

### Fixed

- MAJOR/MINOR/PATCH Description (#PR).
5 changes: 3 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,9 @@
[![Build Status](https://github.com/lethe-cfd/lethe/workflows/CI/badge.svg)](https://github.com/lethe-cfd/lethe/workflows/CI/badge.svg)

Lethe (pronounced /ˈliːθiː/) is open-source computational fluid dynamics
(CFD) software which uses high-order continuous Galerkin formulations to
solve the incompressible Navier–Stokes equations (among others).
(CFD), discrete element method (DEM) and coupled CFD-DEM
software which uses high-order continuous Galerkin formulations to
simulate single and multiphase flows.
Lethe contains a family of solvers that are based on
[deal.II](https://www.dealii.org/), a finite element library.
Through deal.II, Lethe uses [Trilinos](https://trilinos.github.io/) for
Expand Down
24 changes: 12 additions & 12 deletions applications/CMakeLists.txt
Original file line number Diff line number Diff line change
@@ -1,19 +1,19 @@
foreach(_target IN ITEMS
cfd_dem_coupling
dem
lethe-fluid-particles
lethe-particles
dem_parameter_template
gd_navier_stokes
gls_navier_stokes
nitsche_navier_stokes
gls_sharp_navier_stokes
gls_vans
mf_navier_stokes
lethe-fluid-block
lethe-fluid
lethe-fluid-nitsche
lethe-fluid-sharp
lethe-fluid-vans
lethe-fluid-matrix-free
initial_conditions
navier_stokes_parameter_template
rpt_3d
rpt_cell_reconstruction_3d
rpt_fem_reconstruction_3d
rpt_l2_projection_3d)
lethe-rpt-3d
lethe-rpt-cell-reconstruction-3d
lethe-rpt-fem-reconstruction-3d
lethe-rpt-l2-projection-3d)
add_subdirectory(${_target})
install(TARGETS ${_target})
endforeach()
3 changes: 0 additions & 3 deletions applications/cfd_dem_coupling/CMakeLists.txt

This file was deleted.

3 changes: 0 additions & 3 deletions applications/dem/CMakeLists.txt

This file was deleted.

3 changes: 0 additions & 3 deletions applications/gd_navier_stokes/CMakeLists.txt

This file was deleted.

3 changes: 0 additions & 3 deletions applications/gls_navier_stokes/CMakeLists.txt

This file was deleted.

3 changes: 0 additions & 3 deletions applications/gls_sharp_navier_stokes/CMakeLists.txt

This file was deleted.

3 changes: 0 additions & 3 deletions applications/gls_vans/CMakeLists.txt

This file was deleted.

3 changes: 3 additions & 0 deletions applications/lethe-fluid-block/CMakeLists.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
add_executable(lethe-fluid-block gd_navier_stokes.cc)
deal_ii_setup_target(lethe-fluid-block)
target_link_libraries(lethe-fluid-block lethe-solvers)
3 changes: 3 additions & 0 deletions applications/lethe-fluid-matrix-free/CMakeLists.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
add_executable(lethe-fluid-matrix-free mf_navier_stokes.cc)
deal_ii_setup_target(lethe-fluid-matrix-free)
target_link_libraries(lethe-fluid-matrix-free lethe-solvers)
3 changes: 3 additions & 0 deletions applications/lethe-fluid-nitsche/CMakeLists.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
add_executable(lethe-fluid-nitsche nitsche_navier_stokes.cc)
deal_ii_setup_target(lethe-fluid-nitsche)
target_link_libraries(lethe-fluid-nitsche lethe-solvers)
3 changes: 3 additions & 0 deletions applications/lethe-fluid-particles/CMakeLists.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
add_executable(lethe-fluid-particles cfd_dem_coupling.cc)
deal_ii_setup_target(lethe-fluid-particles)
target_link_libraries(lethe-fluid-particles lethe-fem-dem)
3 changes: 3 additions & 0 deletions applications/lethe-fluid-sharp/CMakeLists.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
add_executable(lethe-fluid-sharp gls_sharp_navier_stokes.cc)
deal_ii_setup_target(lethe-fluid-sharp)
target_link_libraries(lethe-fluid-sharp lethe-fem-dem)
3 changes: 3 additions & 0 deletions applications/lethe-fluid-vans/CMakeLists.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
add_executable(lethe-fluid-vans gls_vans.cc)
deal_ii_setup_target(lethe-fluid-vans)
target_link_libraries(lethe-fluid-vans lethe-fem-dem)
File renamed without changes.
3 changes: 3 additions & 0 deletions applications/lethe-fluid/CMakeLists.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
add_executable(lethe-fluid gls_navier_stokes.cc)
deal_ii_setup_target(lethe-fluid)
target_link_libraries(lethe-fluid lethe-solvers)
3 changes: 3 additions & 0 deletions applications/lethe-particles/CMakeLists.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
add_executable(lethe-particles dem.cc)
deal_ii_setup_target(lethe-particles)
target_link_libraries(lethe-particles lethe-core lethe-dem)
File renamed without changes.
3 changes: 3 additions & 0 deletions applications/lethe-rpt-3d/CMakeLists.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
add_executable(lethe-rpt-3d rpt_3d.cc)
deal_ii_setup_target(lethe-rpt-3d)
target_link_libraries(lethe-rpt-3d lethe-rpt)
File renamed without changes.
3 changes: 3 additions & 0 deletions applications/lethe-rpt-cell-reconstruction-3d/CMakeLists.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
add_executable(lethe-rpt-cell-reconstruction-3d rpt_cell_reconstruction_3d.cc)
deal_ii_setup_target(lethe-rpt-cell-reconstruction-3d)
target_link_libraries(lethe-rpt-cell-reconstruction-3d lethe-rpt)
3 changes: 3 additions & 0 deletions applications/lethe-rpt-fem-reconstruction-3d/CMakeLists.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
add_executable(lethe-rpt-fem-reconstruction-3d rpt_fem_reconstruction_3d.cc)
deal_ii_setup_target(lethe-rpt-fem-reconstruction-3d)
target_link_libraries(lethe-rpt-fem-reconstruction-3d lethe-rpt)
3 changes: 3 additions & 0 deletions applications/lethe-rpt-l2-projection-3d/CMakeLists.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
add_executable(lethe-rpt-l2-projection-3d rpt_l2_projection_3d.cc)
deal_ii_setup_target(lethe-rpt-l2-projection-3d)
target_link_libraries(lethe-rpt-l2-projection-3d lethe-rpt)
3 changes: 0 additions & 3 deletions applications/mf_navier_stokes/CMakeLists.txt

This file was deleted.

3 changes: 0 additions & 3 deletions applications/nitsche_navier_stokes/CMakeLists.txt

This file was deleted.

3 changes: 0 additions & 3 deletions applications/rpt_3d/CMakeLists.txt

This file was deleted.

3 changes: 0 additions & 3 deletions applications/rpt_cell_reconstruction_3d/CMakeLists.txt

This file was deleted.

3 changes: 0 additions & 3 deletions applications/rpt_fem_reconstruction_3d/CMakeLists.txt

This file was deleted.

3 changes: 0 additions & 3 deletions applications/rpt_l2_projection_3d/CMakeLists.txt

This file was deleted.

22 changes: 11 additions & 11 deletions applications_tests/CMakeLists.txt
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
add_subdirectory(cfd_dem_coupling)
add_subdirectory(dem)
add_subdirectory(gd_navier_stokes)
add_subdirectory(gls_navier_stokes)
add_subdirectory(gls_sharp_navier_stokes)
add_subdirectory(gls_vans)
add_subdirectory(lethe-fluid-particles)
add_subdirectory(lethe-particles)
add_subdirectory(lethe-fluid-block)
add_subdirectory(lethe-fluid)
add_subdirectory(lethe-fluid-sharp)
add_subdirectory(lethe-fluid-vans)
add_subdirectory(initial_conditions)
add_subdirectory(mf_navier_stokes)
add_subdirectory(nitsche_navier_stokes)
add_subdirectory(rpt_cell_reconstruction_3d)
add_subdirectory(rpt_fem_reconstruction_3d)
add_subdirectory(rpt_l2_projection_3d)
add_subdirectory(lethe-fluid-matrix-free)
add_subdirectory(lethe-fluid-nitsche)
add_subdirectory(lethe-rpt-cell-reconstruction-3d)
add_subdirectory(lethe-rpt-fem-reconstruction-3d)
add_subdirectory(lethe-rpt-l2-projection-3d)
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
set(TEST_TARGET gd_navier_stokes)
set(TEST_TARGET lethe-fluid-block)

file(COPY 2d_channel.msh DESTINATION "${CMAKE_CURRENT_BINARY_DIR}")
file(COPY cylinder_structured.msh DESTINATION "${CMAKE_CURRENT_BINARY_DIR}")
Expand All @@ -7,6 +7,6 @@ file(COPY square.msh DESTINATION "${CMAKE_CURRENT_BINARY_DIR}")
deal_ii_pickup_tests()

if(CMAKE_BUILD_TYPE STREQUAL "Debug")
set_tests_properties(gd_navier_stokes/mms3d_gd.mpirun=2.debug PROPERTIES TIMEOUT 2000)
set_tests_properties(lethe-fluid-block/mms3d_gd.mpirun=2.debug PROPERTIES TIMEOUT 2000)
endif()

Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
set(TEST_TARGET mf_navier_stokes)
set(TEST_TARGET lethe-fluid-matrix-free)

string(TOLOWER ${CMAKE_BUILD_TYPE} _build_type)

Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
set(TEST_TARGET nitsche_navier_stokes)
set(TEST_TARGET lethe-fluid-nitsche)


string(TOLOWER ${CMAKE_BUILD_TYPE} _build_type)
Expand All @@ -25,6 +25,6 @@ file(COPY two-bar-mixer-restart/restart_solid_triangulation_01.pvdhandler DESTIN
deal_ii_pickup_tests()

if(CMAKE_BUILD_TYPE STREQUAL "Debug")
set_tests_properties(nitsche_navier_stokes/noslip_22.debug PROPERTIES TIMEOUT 1200)
set_tests_properties(lethe-fluid-nitsche/noslip_22.debug PROPERTIES TIMEOUT 1200)
endif()

Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
set(TEST_TARGET cfd_dem_coupling)
set(TEST_TARGET lethe-fluid-particles)

string(TOLOWER ${CMAKE_BUILD_TYPE} _build_type)

Expand Down Expand Up @@ -53,8 +53,8 @@ file(COPY periodic_particles_qcm_files/dem.triangulation_variable.data DESTINATI
deal_ii_pickup_tests()

if(CMAKE_BUILD_TYPE STREQUAL "Debug")
set_tests_properties(cfd_dem_coupling/particle_sedimentation.debug PROPERTIES TIMEOUT 1200)
set_tests_properties(cfd_dem_coupling/restart_particle_sedimentation.debug PROPERTIES TIMEOUT 1200)
set_tests_properties(cfd_dem_coupling/dynamic_contact_search.debug PROPERTIES TIMEOUT 1200)
set_tests_properties(cfd_dem_coupling/liquid_fluidized_bed.debug PROPERTIES TIMEOUT 2400)
set_tests_properties(lethe-fluid-particles/particle_sedimentation.debug PROPERTIES TIMEOUT 1200)
set_tests_properties(lethe-fluid-particles/restart_particle_sedimentation.debug PROPERTIES TIMEOUT 1200)
set_tests_properties(lethe-fluid-particles/dynamic_contact_search.debug PROPERTIES TIMEOUT 1200)
set_tests_properties(lethe-fluid-particles/liquid_fluidized_bed.debug PROPERTIES TIMEOUT 2400)
endif()
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
IF(DEAL_II_WITH_OPENCASCADE)
add_subdirectory(opencascade)
ENDIF()
set(TEST_TARGET gls_sharp_navier_stokes)
set(TEST_TARGET lethe-fluid-sharp)

string(TOLOWER ${CMAKE_BUILD_TYPE} _build_type)

Expand All @@ -23,10 +23,10 @@ file(COPY rbf_sphere_adaptive.input DESTINATION "${CMAKE_CURRENT_BINARY_DIR}/rbf
deal_ii_pickup_tests()

if(CMAKE_BUILD_TYPE STREQUAL "Debug")
set_tests_properties(gls_sharp_navier_stokes/steady_couette_sphere.debug PROPERTIES TIMEOUT 2000)
set_tests_properties(gls_sharp_navier_stokes/check_point.debug PROPERTIES TIMEOUT 2000)
set_tests_properties(gls_sharp_navier_stokes/pp_contact_test.debug PROPERTIES TIMEOUT 2000)
set_tests_properties(gls_sharp_navier_stokes/pp_lubrication_test.debug PROPERTIES TIMEOUT 2000)
set_tests_properties(gls_sharp_navier_stokes/coupled_moving_stokes.mpirun=2.debug PROPERTIES TIMEOUT 2000)
set_tests_properties(gls_sharp_navier_stokes/pw_contact_test.debug PROPERTIES TIMEOUT 2000)
set_tests_properties(lethe-fluid-sharp/steady_couette_sphere.debug PROPERTIES TIMEOUT 2000)
set_tests_properties(lethe-fluid-sharp/check_point.debug PROPERTIES TIMEOUT 2000)
set_tests_properties(lethe-fluid-sharp/pp_contact_test.debug PROPERTIES TIMEOUT 2000)
set_tests_properties(lethe-fluid-sharp/pp_lubrication_test.debug PROPERTIES TIMEOUT 2000)
set_tests_properties(lethe-fluid-sharp/coupled_moving_stokes.mpirun=2.debug PROPERTIES TIMEOUT 2000)
set_tests_properties(lethe-fluid-sharp/pw_contact_test.debug PROPERTIES TIMEOUT 2000)
endif()
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
IF(DEAL_II_WITH_OPENCASCADE)
set(TEST_TARGET gls_sharp_navier_stokes)
set(TEST_TARGET lethe-fluid-sharp)

string(TOLOWER ${CMAKE_BUILD_TYPE} _build_type)

Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
set(TEST_TARGET gls_vans)
set(TEST_TARGET lethe-fluid-vans)

string(TOLOWER ${CMAKE_BUILD_TYPE} _build_type)

Expand Down Expand Up @@ -77,13 +77,13 @@ file(COPY gidaspow_packed_bed_files/dem.triangulation_variable.data DESTINATION
deal_ii_pickup_tests()

if(CMAKE_BUILD_TYPE STREQUAL "Debug")
set_tests_properties(gls_vans/pcm_packed_bed.debug PROPERTIES TIMEOUT 1200)
set_tests_properties(gls_vans/spm_packed_bed.debug PROPERTIES TIMEOUT 1200)
set_tests_properties(gls_vans/qcm_packed_bed.debug PROPERTIES TIMEOUT 1600)
set_tests_properties(gls_vans/difelice_packed_bed.debug PROPERTIES TIMEOUT 1200)
set_tests_properties(gls_vans/rong_packed_bed.debug PROPERTIES TIMEOUT 1200)
set_tests_properties(gls_vans/dallavalle_packed_bed.debug PROPERTIES TIMEOUT 1200)
set_tests_properties(gls_vans/kochhill_packed_bed.debug PROPERTIES TIMEOUT 1200)
set_tests_properties(gls_vans/beetstra_packed_bed.debug PROPERTIES TIMEOUT 1200)
set_tests_properties(gls_vans/gidaspow_packed_bed.debug PROPERTIES TIMEOUT 1200)
set_tests_properties(lethe-fluid-vans/pcm_packed_bed.debug PROPERTIES TIMEOUT 1200)
set_tests_properties(lethe-fluid-vans/spm_packed_bed.debug PROPERTIES TIMEOUT 1200)
set_tests_properties(lethe-fluid-vans/qcm_packed_bed.debug PROPERTIES TIMEOUT 1600)
set_tests_properties(lethe-fluid-vans/difelice_packed_bed.debug PROPERTIES TIMEOUT 1200)
set_tests_properties(lethe-fluid-vans/rong_packed_bed.debug PROPERTIES TIMEOUT 1200)
set_tests_properties(lethe-fluid-vans/dallavalle_packed_bed.debug PROPERTIES TIMEOUT 1200)
set_tests_properties(lethe-fluid-vans/kochhill_packed_bed.debug PROPERTIES TIMEOUT 1200)
set_tests_properties(lethe-fluid-vans/beetstra_packed_bed.debug PROPERTIES TIMEOUT 1200)
set_tests_properties(lethe-fluid-vans/gidaspow_packed_bed.debug PROPERTIES TIMEOUT 1200)
endif()
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
Loading

0 comments on commit 337c93d

Please sign in to comment.