GGGGGGGGG      GGGG      GGGGGGGGG  GGGGGG   GGGGGG  GGGGGGGGGG
    GGGG            GGGG     GGGG        GGGGGG  GGGGGG  GGGG   GGGG
   GGGG         GGGGGGGGGGGG GGGGGGGGG   G GGGG  G GGGG GGGG    GGGG
   GGGG GGGGGG GGGGGGGGGGGGG GGGGGGGGGG GG GGGG GG GGGG GGGG   GGGGG
  GGGGG  GGGGG GGGGGGGGGGGG  GGGGGGGGG  GG GGGGGG GGGG  GGGG   GGGG
  GGGG   GGGG      GGGG           GGGG  GG  GGGG  GGGG  GGGG   GGGG
   GGGGGGGGGG      GGGG     GGGGGGGGG  GG   GGG   GGGG  GGGGGGGGGG

======================================================================
=====             Geometry plus Simulation modules               =====
=====                   https://github.com/gismo                 =====
======================================================================

Continuous Integration status

System	Status	More information
CDash		Report results from all builds
Circle CI		MacOS XCode 14.3 (x86_64/arm64)
GitLab		Linux non-default configurations
GitHub Actions		Latest Linux/MacOS/Windows
GitLab-Inria		CI at Inria
OpenSUSE		Latest OpenSUSE build as part of the science repository
GCC Farm	Status	Builders from the GCC Farm
OBS		Upstream binaries for Linux distributions
Launchpad	binaries	Upstream package builds for Ubuntu distributions

This README file contains brief information. More details are found ina the Wiki pages.

The latest revision of the code can be obtained using git (via https):

git clone https://github.com/gismo/gismo.git

or as a tar.gz or zip file:

• https://github.com/gismo/gismo/archive/dev.tar.gz
• https://github.com/gismo/gismo/archive/dev.zip

Prerequisites

• Operating systems:

  • MS Windows
  • Linux
  • macOS
  • FreeBSD

• Configuration: CMake 2.8.12 or newer.

• Compilers tested include recent versions of

  • AMD Optimizing C/C++ Compiler
  • AppleClang see here for OpenMP support
  • Clang
  • GNU GCC
  • Intel C++ compiler
  • Mingw64
  • MS Visual Studio C++
  • PGI C/C++ only with GISMO_WITH_OPENMP=OFF

• Compilers known to not work

  • Oracle Developer Studio fails to compile Eigen
  • IBM XLC C/C++ fails to compile Eigen

• Recommended:

  • Doxygen for generating documentation.
  • Paraview for visualization.

Compilation

The compilation requires configuration using CMake at a new, empty folder (in-source builds are disabled).

• On Linux/macOS: A Unix makefile exists in the root source folder. Running make creates a sub folder named build and executes CMake and compilation inside that folder. Alternatively, choose your own build folder and execute CMake pointing to the sources.

• On MS Windows:

  • To compile G+Smo natively, you can use MS Visual Studio which has built-in CMake support since version 2015. Alternatively, you can run the cmake-gui tool (from an environment that is configured with your compiler) to generate makefiles (or Visual Studio project files). Then execute the make tool to launch compilation. Alternatively, use the QtCreator GUI and open the CMakeLists.txt file on the root folder to create a QtCreator project.

  • Another option is to install Windows Subsystem for Linux which:

    lets developers install a Linux distribution [...] and use Linux applications, utilities, and Bash command-line tools directly on Windows, unmodified, without the overhead of a traditional virtual machine or dualboot setup.

    Then you can download, compile and use G+Smo as if your were using a native Linux machine.

After successful compilation a dynamic library is created in ./lib and executable example programs are output at the ./bin subdirectory of the build folder.

Additionally, if Doxygen is available on the system one can execute (eg. on Linux):

make doc

to obtain the Doxygen documentation in HTML format. The main doxygen page is at ./doc/html/index.html.

More information at https://github.com/gismo/gismo/wiki

Optional modules

There is a number of optional modules that may be enabled.

To enable e.g. gsSpectra and gsOpenCascade set the following option in CMake:

-D GISMO_OPTIONAL="gsSpectra;gsOpenCascade"

Configuration Options

The available options are displayed at CMake configuration. Short description and default setting follows:

• CMAKE_BUILD_TYPE Release

  Available values are the standard CMake build configurations: Debug, Release, RelWithDebInfo, MinSizeRel.

• GISMO_COEFF_TYPE double

  The arithmetic type to be used for all computations. Available options include double, long double, float.

• GISMO_EXTRA_INSTANCE not set

  If set to one or more of the options available for GISMO_COEFF_TYPE the G+Smo library is compiled with extra arithmetic types enabled.

• GISMO_WITH_XDEBUG OFF

  If set to ON additional debugging tools are enabled during compilation. These include checked iterators for GCC and MSVC compilers and call stack back-trace printout when a runtime exception occurs.

• GISMO_BUILD_LIB ON

  If enabled a dynamic library is created using GISMO_COEFF_TYPE arithmetic. A target for a static library named gismo_static is also created but not compiled by default.

• GISMO_BUILD_EXAMPLES ON

  If enabled the programs in the examples folder are compiled, and executables are created in build-folder/bin.

• GISMO_BUILD_UNITTESTS OFF

  If enabled the tests in the unittests folder are compiled, and an executable is created in build-folder/bin.

• GISMO_PLUGIN_AXL OFF

  If enabled the plugin for Axel modeler is compiled (requires Axel).

• gsOpennurbs

  Extension for reading and writing of Rhinoceros' 3DM.

• CMAKE_INSTALL_PREFIX (system dependent)

  The location for installation of the library, e.g. /usr/local on some Linux systems.

Directory structure

The source tree consists of the following sub-folders:

• src

Contains all source files. Code is partitioned into modules. Currently eleven modules are present as sub-folders:

• gsCore
• gsMatrix
• gsNurbs
• gsHSplines
• gsModeling
• gsAssembler
• gsSolver
• gsPde
• gsTensor
• gsIO
• gsUtils

• examples

  Examples of usage, small programs and tutorials.

• unittests

  Unittests for some parts of the codebase.

• filedata

  Data files in the XML format the G+Smo can read and write.

• extensions

  Optional additional features that can be compiled along G+Smo.

• plugins

  The plugins for:

  • Axel modeler
  • Rhinoceros' 3DM

• cmake

  Cmake configuration files.

• doc

  Files related to doxygen documentation.

Third-party repository distribution

• openSUSE Science Project: https://en.opensuse.org/openSUSE:Science_Math
• FreeBSD port: https://www.freshports.org/math/gismo/
• Ubuntu upstream packages: https://launchpad.net/~g+smo/+archive/ubuntu/upstream

Contact and support

• Wiki pages:

  https://github.com/gismo/gismo/wiki

• Bug reports:

  https://github.com/gismo/gismo/issues

• Questions (Q&A):

  https://github.com/gismo/gismo/discussions/categories/q-a

People

Coordinator and maintainer: Angelos Mantzaflaris

See full list in our wiki pages

OS-license

The G+Smo library is distributed under the Mozilla Public License v2.0. (see LICENSE.txt).