Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
7 changes: 3 additions & 4 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -139,9 +139,9 @@ build/*
**/build

*.mtx
*.eps
*.pdf
*.msh
*.eps
*.pdf
*.msh
*.geo
*.txt
*.gp
Expand All @@ -156,5 +156,4 @@ tanmat.svg
*.plt
*.csv


docs/docs-api/.obsidian
848 changes: 1 addition & 847 deletions CHANGELOG.md

Large diffs are not rendered by default.

17 changes: 6 additions & 11 deletions docs/about/BaseMethods.table.js
Original file line number Diff line number Diff line change
Expand Up @@ -261,23 +261,18 @@ export const basemethods_articles = [
// ----------------------------------------------------------------------------
export const basemethods_columns = [
{
Header: "Module",
accessor: "title",
header: "Module",
accessorKey: "title",
className: "pester-data-table left",
// Cell: ({ cell: { value }, row: { original } }) => (
// <a href={`${original.url}`} target="blank" rel="noreferrer noopener">
// {value}
// </a>
// ),
},
{
Header: "Comment",
accessor: "comment",
header: "Comment",
accessorKey: "comment",
className: "pester-data-table left",
},
{
Header: "Category",
accessor: "category",
header: "Category",
accessorKey: "category",
className: "pester-data-table",
},
];
17 changes: 6 additions & 11 deletions docs/about/BaseType.table.js
Original file line number Diff line number Diff line change
Expand Up @@ -311,23 +311,18 @@ export const basetype_articles = [
// ----------------------------------------------------------------------------
export const basetype_columns = [
{
Header: "Data-type",
accessor: "title",
header: "Data-type",
accessorKey: "title",
className: "pester-data-table left",
// Cell: ({ cell: { value }, row: { original } }) => (
// <a href={`${original.url}`} target="blank" rel="noreferrer noopener">
// {value}
// </a>
// ),
},
{
Header: "Summary",
accessor: "comment",
header: "Summary",
accessorKey: "comment",
className: "pester-data-table left",
},
{
Header: "Category",
accessor: "category",
header: "Category",
accessorKey: "category",
className: "pester-data-table",
},
];
2 changes: 0 additions & 2 deletions docs/about/easifemBase.md
Original file line number Diff line number Diff line change
Expand Up @@ -59,8 +59,6 @@ The `easifemBase` library exposes three main modules.

The structure of source directory is shown in the following figure.

<!-- ![easifem-base-design](/img/svg/easifem-base-design.svg) -->

import EasifemBaseDesign from '@site/static/img/svg/easifem-base-design.svg';

<EasifemBaseDesign title="easifemBase design" className="logo" />;
Expand Down
17 changes: 6 additions & 11 deletions docs/about/easifemClasses.table.js
Original file line number Diff line number Diff line change
Expand Up @@ -186,23 +186,18 @@ export const easifemClasses_articles = [
// ----------------------------------------------------------------------------
export const easifemClasses_columns = [
{
Header: "Module",
accessor: "title",
header: "Module",
accessorKey: "title",
className: "pester-data-table left",
// Cell: ({ cell: { value }, row: { original } }) => (
// <a href={`${original.url}`} target="blank" rel="noreferrer noopener">
// {value}
// </a>
// ),
},
{
Header: "Comment",
accessor: "comment",
header: "Comment",
accessorKey: "comment",
className: "pester-data-table left",
},
{
Header: "Category",
accessor: "category",
header: "Category",
accessorKey: "category",
className: "pester-data-table",
},
];
49 changes: 4 additions & 45 deletions docs/about/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ Currently, EASIFEM focuses on finite element methods. Eventually, the library wi

![easifem structure](/img/what-is-easifem.svg)

EASIFEM consists following three hierarchical components:
Easifem consists following three hierarchical components:

- **Base** `libeasifemBase`
- **Classes** `libeasifemClasses`
Expand All @@ -41,41 +41,13 @@ EASIFEM consists following three hierarchical components:
Currently, `easifemBase` has interface with `BLAS95`, `Lapack95`, `Sparsekit`, `Metis`, `PlPlot`, `SuperLU`, `ARPACK`, etc.
:::

import Link from '@docusaurus/Link';

<div className='container margin-vert--lg'>
<div className='row row--no-gutters'>
<div className="col col--5">
<Link to="/guides/getting-started/easifemBase" className="button button--lg button--outline button--block button--primary">Get Started with easifemBase</Link>
</div>
<div className="col col--2">
</div>
<div className="col col--5">
<Link to="/guides/getting-started" className="button button--lg button--outline button--block button--primary">Get Started with easifem</Link>
</div>
</div>
</div>

## Classes

`easifemClasses` (hereafter, read as the Classes) defines high-level derived types such as domain, mesh, fields, linear solvers, etc. Classes are primarily based on [object-oriented programming](https://en.wikipedia.org/wiki/Object-oriented_programming). Most of the functionality of Classes comes from the Base. In other words, most of the computation is deployed to the Base library. This approach improves flexibility at the cost of reducing some speed.
:::info `Classes`
Currently, `easifemBase` has interface with `HDF5`, `Gmsh`, `PlPlot`, `GTK4`, `PETsc`, `Matplotlib`, `Python`, `Lua`, etc. In the future, we will add interfaces to many other useful FORTRAN and C libraries.
:::

<div className='container margin-vert--lg'>
<div className='row row--no-gutters'>
<div className="col col--5">
<Link to="/guides/getting-started/easifemClasses" className="button button--lg button--outline button--block button--primary">Get Started with easifemClasses</Link>
</div>
<div className="col col--2">
</div>
<div className="col col--5">
<Link to="/guides/getting-started" className="button button--lg button--outline button--block button--primary">Get Started with easifem</Link>
</div>
</div>
</div>

## Kernels

`easifemKernels` (henceforth, read as Kernels) contains physics simulators. For example, we have:
Expand All @@ -93,30 +65,17 @@ Currently, `easifemBase` has interface with `HDF5`, `Gmsh`, `PlPlot`, `GTK4`, `P
- Incompressible and Isothermal Navier-Stokes Flow
- Space-Time Finite element methods

<div className='container margin-vert--lg'>
<div className='row row--no-gutters'>
<div className="col col--5">
<Link to="/guides/getting-started/easifemClasses" className="button button--lg button--outline button--block button--primary">Get Started with easifemClasses</Link>
</div>
<div className="col col--2">
</div>
<div className="col col--5">
<Link to="/guides/getting-started" className="button button--lg button--outline button--block button--primary">Get Started with easifem</Link>
</div>
</div>
</div>

## Programming paradigm

EASIFEM manly follows two types of programming paradigm:
Easifem manly follows two types of programming paradigm:

- Object-oriented-programming (OOP)
- Multi-dispatch programming.

## System requirements

Before installing the EASIFEM, please make sure your system is up-to-date and have requirements mentioned [here.](./SystemRequirements.md)
Before installing the Easifem, please make sure your system is up-to-date and have requirements mentioned [here.](./SystemRequirements.md)

## External packages

Before installing the EASIFEM, make sure to install the external packages on your system by following the details given [here.](./SystemRequirements.md)
Before installing the Easifem, make sure to install the external packages on your system by following the details given [here.](./SystemRequirements.md)
16 changes: 16 additions & 0 deletions docs/blog/authors.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
vickysharma0812:
name: Vikas Sharma
title: Assistant Professor, Kyoto University, Japan
url: https://github.com/vickysharma0812
image_url: https://raw.githubusercontent.com/easifem/authors/refs/heads/main/images/vickysharma0812.jpg
socials:
x: vickysharma0812
github: vickysharma0812

shishiousan:
name: Shion Shimizu
title: Doctoral Student, Kyoto University, Japan
url: https://github.com/shishiousan
image_url: https://raw.githubusercontent.com/easifem/authors/refs/heads/main/images/shishiousan.jpg
socials:
github: shishiousan
Loading