From c1cb489a6938c046f88e029c35ad8fa12aebefb0 Mon Sep 17 00:00:00 2001 From: Max Luebke Date: Fri, 12 Aug 2022 19:02:23 +0200 Subject: [PATCH 1/2] Add git-chglog template for changelog creation --- .chglog/CHANGELOG.tpl.md | 38 ++++++++++++++++++++++++++++++++++++++ .chglog/config.yml | 27 +++++++++++++++++++++++++++ 2 files changed, 65 insertions(+) create mode 100755 .chglog/CHANGELOG.tpl.md create mode 100755 .chglog/config.yml diff --git a/.chglog/CHANGELOG.tpl.md b/.chglog/CHANGELOG.tpl.md new file mode 100755 index 0000000..d75abe5 --- /dev/null +++ b/.chglog/CHANGELOG.tpl.md @@ -0,0 +1,38 @@ +{{ range .Versions }} + +## {{ 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 -}} \ No newline at end of file diff --git a/.chglog/config.yml b/.chglog/config.yml new file mode 100755 index 0000000..5cfabf4 --- /dev/null +++ b/.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 \ No newline at end of file From 38700f2968726bb6d6a7802dc9e7968edfd7d6e7 Mon Sep 17 00:00:00 2001 From: Max Luebke Date: Fri, 12 Aug 2022 19:03:31 +0200 Subject: [PATCH 2/2] Add Changelog --- Changelog.md | 12 ++++++++++++ 1 file changed, 12 insertions(+) create mode 100644 Changelog.md diff --git a/Changelog.md b/Changelog.md new file mode 100644 index 0000000..7035502 --- /dev/null +++ b/Changelog.md @@ -0,0 +1,12 @@ + + +## 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