MPS-Basic

Modernized Moving Particle Semi-implicit/Simulation method code written in C++.

Note

See Documentation for more information

Requirements

Execution

• C++ 17 compiler
• Git
• CMake (newer than 3.12)
• OpenMP 5.0 and above (optional)

Development

• Doxygen and Graphviz (optional, for building documents)

Dependencies

• argparse
• Eigen
• fast-cpp-csv-parser
• yaml-cpp

Development

• GoogleTest (only for testing)

Execution

Build

1. Generate build system

   cmake -S . -B build

   If you use cmake 4.0 or later, you need to add -DCMAKE_POLICY_VERSION_MINIMUM=3.5 to the above command.
2. Execute build

   cmake --build build

Execution

Windows

1. Create output directory if not exist

   New-Item -ItemType Directory -Path result/dambreak -Force

2. Remove old output files if exist

   Remove-Item -Path $outputDir/* -Force -Recurse

3. Run simulation

   ./build/mps.exe --setting input/dambreak/settings.yml --output result/dambreak 2> result/dambreak/error.log | Tee-Object -FilePath "result/dambreak/console.log"

Linux/Mac

1. Create output directory if not exist

   mkdir -p result/dambreak/

2. Remove old output files if exist

   rm -rf result/dambreak/*

3. Run simulation

   ./build/mps --setting input/dambreak/settings.yml --output result/dambreak 2> result/dambreak/error.log | tee result/dambreak/console.log

Checking Results

Result files will be written in result/dambreak/vtu/***.vtu. Open these files in ParaView to see the result.

Build documents

Note

Install dependencies as shown above for the first build

git submodule update --init doxygen-awesome-css

doxygen Doxyfile

• You can see the documents in doxygen/html/index.html.
• If you want PDF files, you can use make command in the doxygen/latex directory (LaTeX is required).

Support

Please ask the authors if you have any questions.

Contributing

Read CONTRIBUTING.md for details.

License

MIT License

Project status

This project is under development.