ukaea / parallel-preprocessor Goto Github PK

View Code? Open in Web Editor NEW

18.0 4.0 9.0 5.28 MB

Parallel-preprocessor: a prototype of parallel CAE geometry preprocessing framework

License: Other

CMake 11.43% C++ 66.68% Python 17.41% Batchfile 0.08% Shell 1.49% C 2.90%

cad cae preprocessing parallel-computing opencascade

parallel-preprocessor's Introduction

Parallel-preprocessor (PPP)

A prototype parallel CAE geometry preprocessing framework

by Qingfeng Xia, UKAEA

License: LGPL v2.1

Documentation

For more information, please see the documentation website (which includes the contents of this Readme file).

Feature overview

This software provides multi-threaded geometry collision detection and imprinting via a command line interface and more advanced json configuration interface. It has faster and more controllable performance on large geometry assemblies (with 10k+ parts) than is possible with most existing CAD tools.

The following screenshot shows the software making good use of multiple CPUs, with high CPU usage across 64 threads on a 32-core CPU. (Source: Dr Andrew Davis)

More details on benchmarking on parallel geometry imprinting can be found in wiki/Benchmarking.md.

Getting started

A quick start guide for using PPP can be found in wiki/GetStarted.md.

Future plans

This software aims to be a framework for more CAE preprocessing operations for large geometry assemblies with up to 1 million parts, such as fusion reactors, aeroplanes and aero engines, using high performance computing infrastructure in exascale supercomputers. Eventually, automatic and intelligent engineering design will be enabled through this framework and other software tools.

wiki/TechOverview.md explains more about why a parallel preprocessor is needed in the era of exascale computing.

wiki/Roadmap.md lists short-term and long-term plans which depend on funding status. Additional funding for enhancing existing modules or developing new modules would be very welcome.

Disclaimer

This is not yet production quality software, but is a prototype which demonstrates the potential of accelerating CAE preprocessing on HPC systems. We hope to improve the software and apply better software engineering practices in future.

There is no warranty for this free library.

Platforms supported

This project has been designed to be cross-platform, and currently a number of Linux distributions are supported:

The latest LTS version of Ubuntu is the primary development platform, and a Debian package is generated by the CI build.
Fedora 30+ with OpenCascade 7.x package available from official repository, with an RPM binary package generated.
MacOS compiling and packaging is done via homebrew, with a DragNDrop binary package generated.
Windows 10 users are encouraged to use WSL with one of the supported Linux distributions. (A guide to native compilation on Windows has been added, but this build is experimental.)
Versions can be built from the source code for other Linux platforms (using CMake and CPack). Centos8 should work without much effort (with OpenCascade compiled from source). The build tools in the Centos7 software stack are too old, so Docker/Singularity should be used for Centos7 support.
Centos8 Docker image is ready for quick started without installation docker pull qingfengxia/ppp-centos This is a small image (size 1.6 GB) based on centos8, with only occt (v7.4) and PPP compiled from source.
Conda packages may be available in the future. See wiki/Packaging.md.

Installation guide

There are instructions for installation in wiki/Installation.md. Runtime dependencies must be installed before PPP release packages (and the easiest way to do this is probably by installing FreeCAD).

Developer guide

Information for developers, such as a guide for building from source, and documentation about the software design and implementation, can be found in wiki/DeveloperGuide.md.

Contributions

Please submit GitHub issues and pull requests!

See more about the workflow for contributions in wiki/Contribution.md.

Acknowledgements

Funding from August 2019 - April 2020 was provided by the STEP project in UKAEA.

Dr Andrew Davis of UKAEA, has contributed his technical insight, test geometries and other support to this software project. Also thanks to other colleagues, including John Nonweiler and Dr Jonathon Shimwell, for testing and reviewing this software.

parallel-preprocessor's People

Contributors

Stargazers

Watchers

Forkers

qingfengxia johnnonweiler shimwell xupeiwust luzpaz fuhuasuiyue cescjf chens08

parallel-preprocessor's Issues

[Enhancement] merge should be done in GeometryImprinter instead of GeometryWriter

Currently merge is done in writer, it is more efficient, easy to impl, but not flexible. if there is more processor following imprinter, must working on merged geometry like Tessellation, it may be useful.

Low priority, this can be done togother with "parallel merge" design

CMake build changes source folders and then stages those changes in git

In some circumstances, the cmake build will do a git submodule add https://github.com/pybind/pybind11 in the src/python folder. (See src/python/CMakeLists.txt)

I would expect the cmake build to normally only change files in the build folder (and not to stage changes in git).

missing file pppStartPipeline

This might be me making the error again but wanted to mention that I'm getting this error, Looks like PPP can't find the pppStartPipeline file and it appears to not have installed with the others

doxygen does not support math equaton and mermaid graph

https://ukaea.github.io/parallel-preprocessor/site/doxygen-docs.html

perimeter calculation is not correct

https://techoverflow.net/2019/06/16/how-to-get-length-of-curve-in-opencascade/

Request for different key name in manifest.json

The manifest.json looks for the tag filename but I was wondering if this could be changed to stp_filename

No worries if it is better to keep it as filename, just thought I would ask

use only one keyword from virtual override final

this is from C++ core guideline.

add support non-standard length unit for CAD input file

Currently, it is assumed, input CAD File unit must be "mm" which is standard for CAD.
scaling from other length unit may be worth of supporting.

errors when running geompipline

When trying to use the geomPipeline.py in ubuntu 18.04 Conda env I get an error and was wondering

I have tried installing additional software sudo apt-get install libstdc++6 but this has not helped

Here are the commands I used to install and run the PPP

sudo add-apt-repository -y ppa:freecad-maintainers/freecad-stable
sudo apt update
sudo install -y freecad
sudo apt-get install -y libtbb2 libocct-foundation-7.3  libocct-data-exchange-7.3  libocct-modeling-data-7.3 libocct-modeling-algorithms-7.3  libocct-ocaf-7.3
wget https://github.com/ukaea/parallel-preprocessor/releases/download/dev/parallel-preprocessor-0.3-dev_ubuntu-20.04.deb
sudo dpkg -i parallel-preprocessor-0.3-dev_ubuntu-20.04.deb 
geomPipeline.py config.json
/home/jshim/anaconda3/bin/python /usr/bin/geomPipeline.py config.json

code improvement according to code analysis: cppcheck code coverage

https://ukaea.github.io/parallel-preprocessor/site/cppcheck.html

clang-tidy empty
flawfinder no output page, why?

coverage, PPP and PPP/CoreTests should merged into one folder to report.

Shape hash or uniqueId algorithm has problem

ukaea/openmc_workshop task10

for small value like centerOfMess.X = 0.014 (before write brep) vs 0.012 (after write out brep in occ_faceter) has diff value,

No material found for ID: 4710765210376886256
with volume: 1.26734e+08, CentreOfMass: 0.0145901, -9.97406e-15, 268.845

"material": "copper",
"name": "divertor.stp",
"property": {
    "area": 2300829.253375523,
    "centerOfMass": [
        0.012942664269858002,
        -1.6442619387761406e-14,
        268.84456044917755
    ],
    "volume": 126733088.77402382
},
"uniqueId": 4710765210367973360

No material found for ID: 13934137247231662064
with volume: 1.26734e+08, CentreOfMass: 0.0145901, -1.254e-14, -268.845

"material": "copper",
"name": "divertor.stp",
"property": {
    "area": 2300829.253375234,
    "centerOfMass": [
        0.012942664144260964,
        -1.43356289324801e-14,
        -268.84456044879204
    ],
    "volume": 126733088.77435534
},
"uniqueId": 13934137247222749168