for studying multi-phase continuum dynamics problems with different runtime environments
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
apps
cinch @ 14b316b
cmake
config
data/meshes
doc
docker
flecsale
flecsi @ b2e0032
ristra @ 9d086e2
specializations @ c4b8b79
tools
.codecov.yml
.gitignore
.gitmodules
.travis.yml
CMakeLists.txt
CONTRIBUTING.md
LICENSE
README.md
flecsale.sublime-project

README.md

FleCSALE

FleCSALE is a computer software package developed for studying problems that can be characterized using continuum dynamics, such as fluid flow. It is specifically developed for existing and emerging large distributed memory system architectures. FleCSALE uses the Flexible Computational Science Infrastructure (FleCSI) project for mesh and data structure support. FleCSALE has support for multi-phase fluids and tabular equation of state (EOS).

Requirements

Minimal

Optional

  • Doxygen to generate documentation
  • Lua >= 5.2 for application input
  • OpenSSL for field data checksums
  • Python >= 2.7 for regression tests
  • VTK to read/write VTK formatted files

Getting the code

This project uses Git for revision control and distribution, and CMake for build configuration. Below are some general instructions for obtaining and building FleCSALE.

FleCSALE uses git submodules, so it mush be checked out recursively. Type

$ git clone --recursive git@github.com:laristra/flecsale.git

to clone the repository using ssh, or

$ git clone --recursive https://github.com/laristra/flecsale.git

to clone using https.

Make sure to include the --recursive so that all of the submodules are cloned as well.

Installation

Building the code is simply performed through the following steps using CMake:

$ mkdir build
$ cd build
$ CC=gcc CXX=g++ cmake /path/to/source/directory -DFLECSI_RUNTIME_MODEL="mpi" -DENABLE_COLORING=on [options]
$ make -j

The environment variables CC and CXX are only necessary to select specific compilers and may be omitted. The first parameter provided to CMake must be the root of the source directory created by cloning the FleCSALE repository.

Options provded to the CMake command line can be any CMake build options listed below (use -Doption_name=value to specify an option. For example, to build the unit tests, specify -DENABLE_UNIT_TESTS=ON.

CMake installation options

  • CMAKE_BUILD_TYPE: Type of build: Release (for users) or Debug (for developers)
  • ENABLE_DOXYGEN: Generate HTML API documentation with Doxygen - Default is OFF
  • ENABLE_LUA: Enable application input with Lua - Defaults to ON if Lua was found
  • ENABLE_REGRESSION_TESTS: Build the regression tests - Defaults to ENABLE_UNIT_TESTS
  • ENABLE_UNIT_TESTS: Build the unit tests - Default is OFF
  • FLECSI_RUNTIME_MODEL: Parallel backend: mpi (for most users), legion, or hpx

Release

This software has been approved for open source release and has been assigned LA-CC-16-076.

Copyright

Copyright (c) 2016, Los Alamos National Security, LLC All rights reserved.

Copyright 2016. Los Alamos National Security, LLC. This software was produced under U.S. Government contract DE-AC52-06NA25396 for Los Alamos National Laboratory (LANL), which is operated by Los Alamos National Security, LLC for the U.S. Department of Energy. The U.S. Government has rights to use, reproduce, and distribute this software. NEITHER THE GOVERNMENT NOR LOS ALAMOS NATIONAL SECURITY, LLC MAKES ANY WARRANTY, EXPRESS OR IMPLIED, OR ASSUMES ANY LIABILITY FOR THE USE OF THIS SOFTWARE. If software is modified to produce derivative works, such modified software should be clearly marked, so as not to confuse it with the version available from LANL.

Additionally, redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

  1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.

  2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.

  3. Neither the name of Los Alamos National Security, LLC, Los Alamos National Laboratory, LANL, the U.S. Government, nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY LOS ALAMOS NATIONAL SECURITY, LLC AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL LOS ALAMOS NATIONAL SECURITY, LLC OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.