From adaa89b49aab5f09f20861f7dcf95f0f17411b94 Mon Sep 17 00:00:00 2001 From: Tom Body Date: Thu, 20 Jun 2024 14:51:30 +0000 Subject: [PATCH] Update documentation for Passing data into expressions --- manual/sphinx/user_docs/variable_init.rst | 20 +++++++++----------- 1 file changed, 9 insertions(+), 11 deletions(-) diff --git a/manual/sphinx/user_docs/variable_init.rst b/manual/sphinx/user_docs/variable_init.rst index 4ac13e0ead..dd7a50cc4a 100644 --- a/manual/sphinx/user_docs/variable_init.rst +++ b/manual/sphinx/user_docs/variable_init.rst @@ -328,22 +328,20 @@ to ``generate`` in the ``Context`` object. Field3D shear = ...; // Value calculated in BOUT++ - FieldFactory factory(mesh); - auto gen = factory->parse("model:viscosity"); + Options& model_options = options["model"]; + auto str = model_options["viscosity"].doc("Viscosity").as; + + auto gen = FieldFactory::get()->parse(str, &model_options); Field3D viscosity; viscosity.allocate(); - - BOUT_FOR(i, viscosity.region("RGN_ALL")) { - viscosity[i] = gen->generate(bout::generator::Context(i, CELL_CENTRE, mesh, 0.0) - .set("shear", shear[i])); + + BOUT_FOR(i, viscosity.getRegion("RGN_ALL")) { + viscosity[i] = gen->generate(bout::generator::Context().set("shear", shear[i])); } -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}`` +In the input options file (or command line) the viscosity can now be written as +a function of ``{shear}`` .. code-block:: cfg