Merge branch 'add-changelog' into 'main'

Add changelog

See merge request sec34/btcsdiffusion!34

.chglog/CHANGELOG.tpl.md

@@ -0,0 +1,38 @@
+{{ range .Versions }}
+<a name="{{ .Tag.Name }}"></a>
+## {{ if .Tag.Previous }}[{{ .Tag.Name }}]({{ $.Info.RepositoryURL }}/compare/{{ .Tag.Previous.Name }}...{{ .Tag.Name }}){{ else }}{{ .Tag.Name }}{{ end }} ({{ datetime "2006-01-02" .Tag.Date }})
+
+{{ range .CommitGroups -}}
+### {{ .Title }}
+
+{{ range .Commits -}}
+* {{ .Subject }}
+{{ end }}
+{{ end -}}
+
+{{- if .RevertCommits -}}
+### Reverts
+
+{{ range .RevertCommits -}}
+* {{ .Revert.Header }}
+{{ end }}
+{{ end -}}
+
+{{- if .MergeCommits -}}
+### Merge Requests
+
+{{ range .MergeCommits -}}
+* {{ .Header }}
+{{ end }}
+{{ end -}}
+
+{{- if .NoteGroups -}}
+{{ range .NoteGroups -}}
+### {{ .Title }}
+
+{{ range .Notes }}
+{{ .Body }}
+{{ end }}
+{{ end -}}
+{{ end -}}
+{{ end -}}

.chglog/config.yml

@@ -0,0 +1,27 @@
+style: gitlab
+template: CHANGELOG.tpl.md
+info:
+  title: CHANGELOG
+  repository_url: https://git.gfz-potsdam.de/sec34/btcsdiffusion
+options:
+  commits:
+    # filters:
+    #   Type:
+    #     - feat
+    #     - fix
+    #     - perf
+    #     - refactor
+  commit_groups:
+    # title_maps:
+    #   feat: Features
+    #   fix: Bug Fixes
+    #   perf: Performance Improvements
+    #   refactor: Code Refactoring
+  header:
+    pattern: "^((\\w+)\\s.*)$"
+    pattern_maps:
+      - Subject
+      - Type
+  notes:
+    keywords:
+      - BREAKING CHANGE

Changelog.md

@@ -0,0 +1,12 @@
+
+<a name="v0.1"></a>
+## v0.1 (2022-08-09)
+
+* Basic solving of diffusion problems with
+  - 1D regular and rectangular grids using BTCS scheme and Eigen SparseLU solver
+  - 2D regular and rectangular grids using 2D-ADI-BTCS scheme and Eigen SparseLU solver
+* Definition of boundary conditions via class `BTCSBoundaryCondition` on ghost nodes 
+* Boundaries types `CLOSED` and `CONSTANT` cells are provided for diffusion problem solving
+* Software testing of both `BTCSDiffusion` and `BTCSBoundaryCondition` classes
+* Description of both BTCS and 2D-ADI-BTCS schemes are provided in `doc`
+* Example applications are attached in `app` subdirectory