Skip to content

README.md

Latest commit

 

History

History
40 lines (26 loc) · 2.28 KB

README.md

File metadata and controls

40 lines (26 loc) · 2.28 KB
Raw

PDEBase.jl

Join the chat at https://julialang.zulipchat.com #sciml-bridged Global Docs

codecov Build Status

ColPrac: Contributor's Guide on Collaborative Practices for Community Packages SciML Code Style

PDEBase.jl provides common types and an interface for building discretizers of ModelingToolkit PDESystems. It serves as a foundation for PDE discretization packages in the SciML ecosystem, such as MethodOfLines.jl.

Overview

This package defines:

  • Abstract types for discretization (AbstractEquationSystemDiscretization, AbstractOptimizationSystemDiscretization)
  • Abstract types for discrete spaces (AbstractDiscreteSpace, AbstractCartesianDiscreteSpace)
  • Boundary condition types (LowerBoundary, UpperBoundary, InterfaceBoundary)
  • Variable mapping utilities (VariableMap, PeriodicMap)
  • Symbolic utilities for parsing and transforming PDE systems
  • Default interface functions for implementing custom discretizers

Installation

using Pkg
Pkg.add("PDEBase")

Usage

PDEBase.jl is primarily intended as a dependency for PDE discretization packages. If you are building a discretizer for ModelingToolkit PDESystems, you can use PDEBase.jl as a foundation by implementing its interface functions.

For solving PDEs directly, consider using MethodOfLines.jl, which builds on PDEBase.jl.

Contributing

If you are using this package or want to use it, please open an issue so we are aware. Contributions and feedback are welcome!