CHANGELOG.md 6.78 KB
Newer Older
1
2
3
4
5
6
7
# Changelog
All notable changes to JuThinFilm will be documented in this file.

The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).

## [Unreleased]
8
9
- Performance test for all functions.
- A clearer and simpler GPU integration.
10

11
<!-- ## [1.0.0] - 2017-06-20
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
### Added
- New visual identity by [@tylerfortune8](https://github.com/tylerfortune8).
- Version navigation.
- Links to latest released version in previous versions.
- "Why keep a changelog?" section.
- "Who needs a changelog?" section.
- "How do I make a changelog?" section.
- "Frequently Asked Questions" section.
- New "Guiding Principles" sub-section to "How do I make a changelog?".
- Simplified and Traditional Chinese translations from [@tianshuo](https://github.com/tianshuo).
- German translation from [@mpbzh](https://github.com/mpbzh) & [@Art4](https://github.com/Art4).
- Italian translation from [@azkidenz](https://github.com/azkidenz).
- Swedish translation from [@magol](https://github.com/magol).
- Turkish translation from [@karalamalar](https://github.com/karalamalar).
- French translation from [@zapashcanon](https://github.com/zapashcanon).
- Brazilian Portugese translation from [@Webysther](https://github.com/Webysther).
- Polish translation from [@amielucha](https://github.com/amielucha) & [@m-aciek](https://github.com/m-aciek).
- Russian translation from [@aishek](https://github.com/aishek).
- Czech translation from [@h4vry](https://github.com/h4vry).
- Slovak translation from [@jkostolansky](https://github.com/jkostolansky).
- Korean translation from [@pierceh89](https://github.com/pierceh89).
- Croatian translation from [@porx](https://github.com/porx).
- Persian translation from [@Hameds](https://github.com/Hameds).
- Ukrainian translation from [@osadchyi-s](https://github.com/osadchyi-s).

### Changed
- Start using "changelog" over "change log" since it's the common usage.
- Start versioning based on the current English version at 0.3.0 to help
translation authors keep things up-to-date.
- Rewrite "What makes unicorns cry?" section.
- Rewrite "Ignoring Deprecations" sub-section to clarify the ideal
  scenario.
- Improve "Commit log diffs" sub-section to further argument against
  them.
- Merge "Why can’t people just use a git log diff?" with "Commit log
  diffs"
- Fix typos in Simplified Chinese and Traditional Chinese translations.
- Fix typos in Brazilian Portuguese translation.
- Fix typos in Turkish translation.
- Fix typos in Czech translation.
- Fix typos in Swedish translation.
- Improve phrasing in French translation.
- Fix phrasing and spelling in German translation.

### Removed
- Section about "changelog" vs "CHANGELOG".

## [0.3.0] - 2015-12-03
### Added
- RU translation from [@aishek](https://github.com/aishek).
- pt-BR translation from [@tallesl](https://github.com/tallesl).
- es-ES translation from [@ZeliosAriex](https://github.com/ZeliosAriex).

## [0.2.0] - 2015-10-06
### Changed
- Remove exclusionary mentions of "open source" since this project can
benefit both "open" and "closed" source projects equally.

## [0.1.0] - 2015-10-06
### Added
- Answer "Should you ever rewrite a change log?".

### Changed
- Improve argument against commit logs.
- Start following [SemVer](https://semver.org) properly.

## [0.0.8] - 2015-02-17
### Changed
- Update year to match in every README example.
- Reluctantly stop making fun of Brits only, since most of the world
  writes dates in a strange way.

### Fixed
- Fix typos in recent README changes.
- Update outdated unreleased diff link.

## [0.0.7] - 2015-02-16
### Added
- Link, and make it obvious that date format is ISO 8601.

### Changed
- Clarified the section on "Is there a standard change log format?".

### Fixed
- Fix Markdown links to tag comparison URL with footnote-style links.

## [0.0.6] - 2014-12-12
### Added
- README section on "yanked" releases.

## [0.0.5] - 2014-08-09
### Added
- Markdown links to version tags on release headings.
- Unreleased section to gather unreleased changes and encourage note
keeping prior to releases.

## [0.0.4] - 2014-08-09
### Added
- Better explanation of the difference between the file ("CHANGELOG")
and its function "the change log".

### Changed
- Refer to a "change log" instead of a "CHANGELOG" throughout the site
to differentiate between the file and the purpose of the file — the
logging of changes.

### Removed
- Remove empty sections from CHANGELOG, they occupy too much space and
create too much noise in the file. People will have to assume that the
missing sections were intentionally left out because they contained no
notable changes.

## [0.0.3] - 2014-08-09
### Added
- "Why should I care?" section mentioning The Changelog podcast.
--->
s.zitz's avatar
s.zitz committed
128

129
## [0.0.2] - 2020-09-02
s.zitz's avatar
s.zitz committed
130

131
### Added
s.zitz's avatar
s.zitz committed
132

133
- Better documentation for the computation of the capillary pressure.
s.zitz's avatar
s.zitz committed
134
- Theory part in most of the docstrings.
135
- Performance tests for the computation of the capillary pressure, see [pressure.jl](test/pressure.jl).
s.zitz's avatar
s.zitz committed
136
- New collision kernels `BGKwithBuickGreatedStream!` and `BGKwithGuoStream!`, Buick and Guo use different force corrections.
s.zitz's avatar
s.zitz committed
137
- Performance tests for the collision kernels, `BGKwithGuoStream!` is the slowest option, further details see [collision.jl](test/collisions.jl).
138
- The gradient of the pressure is now calculated with a circular padded array and is called `h∇p!`.
139
- Performance tests for all available forces, `slippage!`, `thermalfluctuations!`, `h∇p!` and `inclinedplane!`, see [forcing.jl](test/forcing.jl)
140
141

### Changed
s.zitz's avatar
s.zitz committed
142
143
144

- Computation of pressure is now mostly vectorized, see [pressure.jl](src/pressure.jl).
- Collision kernels moved from looping to vectorization with broadcasting, for details see [collision.jl](src/collision.jl).
s.zitz's avatar
s.zitz committed
145
- The default collision operation was renamed to `BGKandStream!` and has now a flag to use the weigthing function correction.
s.zitz's avatar
s.zitz committed
146
- Vectorization of equilibrium calculation in function `equilibrium!`, see [equilibrium!.jl](src/equilibria.jl).
147
- structs are no longer exported, to initialize them use `JuThinFilm.name` with the name of the struct.
s.zitz's avatar
s.zitz committed
148
- Docstrings of all functions have been updated accordingly.
149
150

### Removed
s.zitz's avatar
s.zitz committed
151

152
- Calculation of the disjoining pressure with `Pi_cuda` has been removed, GPU functionality needs further testing.
s.zitz's avatar
s.zitz committed
153
- Kernels have been removed such `kernel_laplacianperiodic!`, `kernel_gradientperiodic!` and `kernel_pressure!` are no longer existing.
s.zitz's avatar
s.zitz committed
154
155
- `kernel_equilibrium!` has been removed in favor of a `equilibrium!` GPU version.
- `velocitysquare` for cumoments has been removed.
s.zitz's avatar
s.zitz committed
156
- `filmpressure!` in favor of `h∇p!`, see [forcing.jl](src/forcing.jl).
157

158
## [0.0.1] - 2020-08-18
s.zitz's avatar
s.zitz committed
159

160
### Added
s.zitz's avatar
s.zitz committed
161

162
163
164
- This CHANGELOG file to document upcoming changes
- README now contains a link to the CHANGELOGs
- Full working relaxing droplet simulation on a patterned substrate see [relaxwithpatch.jl](scripts/relaxwithpatch.jl)