Skip to content
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

Update documentation for Passing data into expressions #2928

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

tbody-cfs
Copy link

@tbody-cfs tbody-cfs commented Jun 20, 2024

Updates docs to match BOUT version used by Hermes-3 master (7d261d4)

.set("shear", shear[i]));

BOUT_FOR(i, viscosity.getRegion("RGN_ALL")) {
viscosity[i] = gen->generate(bout::generator::Context().set("shear", shear[i]));
Copy link
Contributor

Choose a reason for hiding this comment

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

This will use the default Context() constructor (https://github.com/boutproject/BOUT-dev/blob/master/include/bout/sys/generator_context.hxx#L19) so "x", "y", "z", "t" will not be defined. Recommend instead using the original Context(i, CELL_CENTRE, mesh, 0.0)

Comment on lines -342 to -346
Note that the ``Context`` constructor takes the index, the cell
location (e.g. staggered), a mesh, and then the time (set to 0.0
here). Additional variables can be ``set``, "shear" in this case. In
the input options file (or command line) the viscosity could now be a
function of ``{shear}``
Copy link
Contributor

Choose a reason for hiding this comment

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

@tbody-cfs any reason why this has been deleted?

Copy link
Contributor

@dschwoerer dschwoerer left a comment

Choose a reason for hiding this comment

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

See also Ben's comment

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants