-
Notifications
You must be signed in to change notification settings - Fork 1k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Additional Nucleation System capabilities and expanded documentation #12130
Conversation
large_media
Outdated
@@ -1 +1 @@ | |||
Subproject commit 6c55e2f9af9616953b98658e909ab9be805ae751 | |||
Subproject commit 5bc3575000cd55ea5ee79af418faf8add3ebb01e |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Caution! This contains a submodule update
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This is intentional. I've added an image to the docs.
Job Documentation on 910fdb4 wanted to post the following: View the site here This comment will be updated on new commits. |
fb0c80c
to
aa0b0c9
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The code looks lovely. The documentation is pretty complete, mostly just typos and one or two major comments. Looking forward to this being merged 👍
modules/phase_field/doc/content/modules/phase_field/Nucleation/DiscreteNucleation.md
Show resolved
Hide resolved
|
||
!listing modules/phase_field/examples/nucleation/refine.i | ||
The free energy penalty based approaces eschew directly modifying conserved |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
"approaces" -> approaches
!listing modules/phase_field/examples/nucleation/refine.i | ||
The free energy penalty based approaces eschew directly modifying conserved | ||
concentration and non-conserved order parameter fields. Instead they bias the | ||
thermodynamocs of the system in a way that drives the formation of nuclei at the |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
"thermodynamocs" -> thermodynamics
locations provided by the discrete nucleation system. Simply stated the local | ||
free energy density is modified to make the nucleated state a lower energy | ||
state. This causes solute to diffuse toward the nucleation site (in the | ||
conserved case) brings about a change in a non-conserved order parameter field. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
"This causes solute to diffuse toward the nucleation site (in the conserved case) brings about a change in a non-conserved order parameter field." This is confusing, I think you're missing some words.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
it is missing an and
modules/phase_field/doc/content/modules/phase_field/Nucleation/DiscreteNucleation.md
Show resolved
Hide resolved
modules/phase_field/doc/content/modules/phase_field/Nucleation/DiscreteNucleation.md
Show resolved
Hide resolved
where $v$ ist the variable the auxkernel is acting on and $M$ is the | ||
[DiscreteNucleationMap](/DiscreteNucleationMap.md)] dataThe map values $M(r)$ | ||
range from 0..1 and are remaped using the $v_0$ (`no_nucleus_value`) and $v_1$ | ||
(`nucleus_value`) parameters. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
couple of typos here. "dataThe" , "remaped"
|
||
!syntax description /Kernels/DiscreteNucleationForce | ||
|
||
It implements the weak for term |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
"weak for" -> "weak form"
|
||
where $u$ ist the variable the kernel is acting on, $M$ is the | ||
[DiscreteNucleationMap](/DiscreteNucleationMap.md)] data, and $\psi$ is a test | ||
function. The map values $M(r)$ range from 0..1 and are remaped using the $v_0$ |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
"remaped" -> remapped
(`no_nucleus_value`) and $v_1$ (`nucleus_value`) parameters. | ||
|
||
This kernel can be used together with the [Reaction](/Reaction.md) kernel to set | ||
a non-linear variable field to an a affine transformation of the discrete |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
"to an a"
aa0b0c9
to
ad95453
Compare
Looks like you need to rebase the large_media update. |
ad95453
to
7e8b78d
Compare
I need to drop the large_media update, because my commits in that module are already in the history below to what the submodule has been set in a recent PR. |
7e8b78d
to
910fdb4
Compare
Piling on a bunch of documentation fixes for issue #12151 while this stews here. |
Adds diagnostic objects and a forcing function kernel for direct order parameter modification.
Closes #12114
Closes #12151