Documentations

The documentations are presented in a manner reflecting the flow of a phyem simulation. Jupyter notebooks 🪐 and Gallery🖼 are complementary to them.

Caution

A most complete phyem simulation would start with inputs defining a problem as a bond graph. However, the bond graph class, as well as its interface to the PDE class, is not implemented yet. As a compromise, the current documentation illustrates a problem defining through the PDE class.

The bond graph class and its interface to the PDE class are key for the LEGO-like feature of phyem. Since they are missing now, this feature is not realized for the time being.

Below we present documentations pf phyem. They demonstrate a phyem simulation for a linear port-Hamiltonian problem. It services as a good clue to understand the overall skeleton of a phyem simulation. Examples for other problems can be found in Jupyter notebooks 🪐 and Gallery🖼. Nevertheless, we recommend users to start with below documentations no matter which type of problem you are targeting at.

Documentations

A Python script that carries out a phyem simulation usually consists of commands for the following functionalities:

• 1. Presetting
  • 1.1. Import
  • 1.2. Set
• 2. Manifold & mesh
  • 2.1. Manifold
  • 2.2. Mesh
• 3. Space & form
  • 3.1. Space
  • 3.2. Form
• 4. PDE
  • 4.1. Initialization
  • 4.2. Boundary conditions
  • 4.3. Derivations
• 5. Weak formulation & discretization
  • 5.1. Weak formulation
  • 5.2. Derivations
  • 5.3. Discretization
• 6. Algebraic proxy
  • 6.1. Matrix proxy
  • 6.2. Algebraic representation
• 7. Implementations
  • 7.1. msepy

More examples can be found at Jupyter notebooks 🪐 and Gallery🖼.

↩️ Back to Welcome.