Science Score: 54.0%
This score indicates how likely this project is to be science-related based on various indicators:
-
✓CITATION.cff file
Found CITATION.cff file -
✓codemeta.json file
Found codemeta.json file -
✓.zenodo.json file
Found .zenodo.json file -
○DOI references
-
✓Academic publication links
Links to: arxiv.org -
○Academic email domains
-
○Institutional organization owner
-
○JOSS paper metadata
-
○Scientific vocabulary similarity
Low similarity (14.0%) to scientific vocabulary
Repository
Basic Info
- Host: GitHub
- Owner: instatdealii
- License: lgpl-3.0
- Language: C++
- Default Branch: main
- Size: 14.4 MB
Statistics
- Stars: 3
- Watchers: 1
- Forks: 6
- Open Issues: 1
- Releases: 1
Metadata Files
Readme.md
Build status of the library against official deal.II docker images:
ideal.II an extension to deal.II for tensor-product space-time finite elements
This library provides classes and functions to solve instationary partial differential equations by using space-time finite elements i.e. finite elements in both time and space. It heavily builds on the 1 to 3d finite element capabilities of deal.II so you should make yourself familiar with solving stationary problems with that library first.
How to install ideal.II
First you need to install deal.II by following the instructions on their site. If you plan on using parallel linear algebra and other advanced features of deal.II and ideal.II you should use either the cmake superbuild or candi. Note down the installation directory of deal.II (for example ~/Software/dealii)
The installation of ideal.II is based on CMake as well, the steps are as follows.
Choose an installation directory for ideal.II (for example ~/Software/idealii)
Open a console and go to a directory where you want to download the source files (e.g. ~/Downloads) and clone the repository
~~~~~ cd ~/Downloads git clone https://github.com/instatdealii/idealii ~~~~~
- After cloning is finished execute the following commands (with the above directory examples write
~/Software/dealii instead of
and ~/Software/idealii instead of
~~~~~
cd idealii
cmake -S. -Bbuild -DDEALIIDIR=
How to use ideal.II in your codes
Take a look at one of the example steps and copy the CMakeLists.txt file from there into your project directory. Set the correct project name and sources and then call the following commands from your project directory.
~~~~~
cmake -S. -Bbuild -DIDEALIIDIR=
Then the executable will be inside the build subdirectory.
How to cite ideal.II
The software metapaper is currently in preparation. Once published the readme will be updated accordingly.
If you write a paper using results obtained with the help of ideal.II, please cite the following reference:
- Jan Philipp Thiele, ideal.II: a Galerkin space-time extension to the finite element library deal.II, preprint(2024), arXiv 2408.08840
~~~~~ @misc{idealII, archiveprefix = {arXiv}, author = {Thiele, Jan Philipp}, eprint = {2408.08840}, primaryclass = {math.NA}, title = {ideal.{II}: a Galerkin Space-Time Extension to the Finite Element Library deal.{II}}, year = {preprint(2024), \url{https://arxiv.org/abs/2408.08840}} } ~~~~~
- Please also cite deal.II as explained here
Documentation
A full documentation including the underlying mathematics (WIP) can be found here.
The doxygen API Reference of the library functions can be found here.
Owner
- Name: instatdealii
- Login: instatdealii
- Kind: organization
- Repositories: 1
- Profile: https://github.com/instatdealii
Citation (CITATION.cff)
title: "ideal.II: a Galerkin Space-Time Extension to the Finite Element Library
deal.II"
authors:
- given-names: Jan Philipp
family-names: Thiele
affiliation: WIAS Berlin
cff-version: 1.2.0
message: If you use this software, please cite it using the metadata from this file.
type: software
doi: https://doi.org/10.48550/arXiv.2408.08840
abstract: An extension to the finite element library deal.II (www.dealii.org)
for tensor-product space-time finite elements
keywords:
- Space time finite elements
- finite elements
- MPI
license: LGPL-3.0
repository-code: https://github.com/instatdealii/idealii
date-released: 2024-08-15
version: v1.0.0
CodeMeta (codemeta.json)
{
"name": "ideal.II: a Galerkin Space-Time Extension to the Finite Element Library deal.II",
"@context": "https://w3id.org/codemeta/3.0",
"applicationCategory": "Scientific",
"author": [
{
"affiliation": {
"name": "WIAS Berlin",
"type": "Organization"
},
"familyName": "Thiele",
"id": "_:author_1",
"givenName": "Jan Philipp",
"type": "Person"
}
],
"contributor": [
{
"affiliation": {
"name": "Leibniz University Hannover",
"type": "Organization"
},
"familyName": "Kinnewig",
"id": "_:contributor_1",
"givenName": "Sebastian",
"type": "Person"
},
{
"affiliation": {
"name": "Colorado State University",
"type": "Organization"
},
"email": "bangerth@colostate.edu",
"familyName": "Bangerth",
"id": "_:contributor_2",
"givenName": "Wolfgang",
"type": "Person"
}
],
"codeRepository": "https://github.com/instatdealii/idealii",
"dateCreated": "2022-08-26",
"dateModified": "2024-08-15",
"datePublished": "2024-08-15",
"description": "An extension to the finite element library deal.II (www.dealii.org) for tensor-product space-time finite elements",
"developmentStatus": "active",
"downloadUrl": "https://github.com/instatdealii/idealii/releases/tag/v1.0.0",
"identifier": "https://doi.org/10.48550/arXiv.2408.08840",
"issueTracker": "https://github.com/instatdealii/idealii/issues",
"keywords": [
"Space time finite elements",
"finite elements",
"MPI"
],
"license": "https://spdx.org/licenses/LGPL-3.0",
"programmingLanguage": [
"C++",
"CMake",
"Hack"
],
"schema:releaseNotes": "# Initial version\r\n\r\n- Four example steps showing usage of the library\r\n - step-1: Heat equation as a prototypical example\r\n - step-2: Stokes equation as an example for coupled problems\r\n - step-3: Heat equation (again) to show usage of MPI parallel linear algebra\r\n - step-4: Navier-Stokes equation as an example of a nonlinear coupled problem\r\n- Doxygen API documentation of the libraries classes and functions\r\n- Sphinx based main documentation \r\n - Explanation of the underlying mathematics (still WIP)\r\n - Documentation of all examples including an introduction, commented source code and discussion of results\r\n ",
"softwareRequirements": [
"www.github.com/dealii/dealii",
""
],
"version": "v1.0.0",
"type": "SoftwareSourceCode"
}
GitHub Events
Total
- Issues event: 1
- Delete event: 74
- Issue comment event: 26
- Push event: 90
- Pull request review event: 21
- Pull request event: 164
- Fork event: 2
- Create event: 83
Last Year
- Issues event: 1
- Delete event: 74
- Issue comment event: 26
- Push event: 90
- Pull request review event: 21
- Pull request event: 164
- Fork event: 2
- Create event: 83
Issues and Pull Requests
Last synced: 6 months ago
All Time
- Total issues: 0
- Total pull requests: 53
- Average time to close issues: N/A
- Average time to close pull requests: 10 days
- Total issue authors: 0
- Total pull request authors: 2
- Average comments per issue: 0
- Average comments per pull request: 0.34
- Merged pull requests: 25
- Bot issues: 0
- Bot pull requests: 51
Past Year
- Issues: 0
- Pull requests: 53
- Average time to close issues: N/A
- Average time to close pull requests: 10 days
- Issue authors: 0
- Pull request authors: 2
- Average comments per issue: 0
- Average comments per pull request: 0.34
- Merged pull requests: 25
- Bot issues: 0
- Bot pull requests: 51
Top Authors
Issue Authors
- jpthiele (1)
- codefair-app[bot] (1)
- dependabot[bot] (1)
Pull Request Authors
- dependabot[bot] (65)
- jpthiele (16)
- step-security-bot (6)
- codefair-app[bot] (3)