Skip to content

Commit

Permalink
Fix doc typos
Browse files Browse the repository at this point in the history
  • Loading branch information
sjdaines authored Jun 24, 2022
1 parent 2f3ff02 commit 77218d1
Showing 1 changed file with 3 additions and 3 deletions.
6 changes: 3 additions & 3 deletions docs/src/CreateInitializeLoop.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,13 +27,13 @@ To initialise the model, the numerical solver or host should then:
- store sorted lists of [`ReactionMethod`](@ref)s and corresponding Variable array accessors in the [`ModelData`](@ref) struct. A [`ReactionMethod`](@ref) may include a prepare function to include additional buffers etc.
- call [`create_dispatch_methodlists`](@ref) to compile default model-wide lists of `initialize` and `do` methods + corresponding Variable array accessors and [`CellRange`](@ref)s. This is stored as the in the `dispatchlists_all` of the [`ModelData`](@ref) struct.
- call [`check_configuration`](@ref) to call any optional [`check_configuration`](@ref) Reaction methods to validate the model configuration.
- call [`dispatch_setup`](@ref) with `attribute_value = :setup`, which calls Reaction setup methods (registered by [`add_method_setup!`](@ref)) to initialise Reaction state and any non-state Variables (eg grid variables).
- call [`dispatch_setup`](@ref) with `attribute_name = :setup`, which calls Reaction setup methods (registered by [`add_method_setup!`](@ref)) to initialise any internal Reaction state and any non-state Variables (eg grid variables).

## State Variable initialization
To initialise state Variables and perform any Reaction-specific initialisation, the numerical solver or host should:
- call [`dispatch_setup`](@ref) with `attribute_value = :norm_value`. These methods should set state Variables according to the `:norm_value` Variable attribute (which can be set in the `variable_attributes:` section of the config file).
- call [`dispatch_setup`](@ref) with `attribute_name = :norm_value`. These Reaction setup methods should set state Variables according to the `:norm_value` Variable attribute (which can be set in the `variable_attributes:` section of the config file). Reactions may also use these values internally.
- optionally (if normalisation values are required by a numerical solver), copy the Variable normalisation values from the arrays in [`ModelData`](@ref) to the solver.
- optionally call [`dispatch_setup`](@ref) with `attribute_value = :initial_value` to set state Variables according to the `:initial_value` Variable attribute (which can be set in the `variable_attributes:` section of the config file).
- optionally call [`dispatch_setup`](@ref) with `attribute_name = :initial_value` to set state Variables according to the `:initial_value` Variable attribute (which can be set in the `variable_attributes:` section of the config file).

## Main loop
To calculate the model derivative, the numerical solver or host should:
Expand Down

2 comments on commit 77218d1

@sjdaines
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@JuliaRegistrator register()

@JuliaRegistrator
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Registration pull request created: JuliaRegistries/General/63043

After the above pull request is merged, it is recommended that a tag is created on this repository for the registered package version.

This will be done automatically if the Julia TagBot GitHub Action is installed, or can be done manually through the github interface, or via:

git tag -a v0.19.0 -m "<description of version>" 77218d17fb9f444bb9b97bf5f90998e54f63b033
git push origin v0.19.0

Please sign in to comment.