Skip to content

Commit 44eb76c

Browse files
authored
fix docs for mesh bp field mfem case, correct entry is basis (#1468)
* fix docs for mesh bp field mfem case, correct entry is basis
1 parent 933b6d7 commit 44eb76c

File tree

1 file changed

+4
-4
lines changed

1 file changed

+4
-4
lines changed

src/docs/sphinx/blueprint_mesh.rst

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -754,7 +754,7 @@ Thus, to conform to protocol, each entry under the ``fields`` section must be an
754754
* Material-Independent Fields:
755755

756756
* fields/field/association: "vertex" | "element"
757-
* fields/field/grid_function: (mfem-style finite element collection name) (replaces "association")
757+
* fields/field/basis: (mfem-style finite element collection name) (replaces "association")
758758
* fields/field/volume_dependent: "true" | "false"
759759
* fields/field/topology: "topo"
760760
* fields/field/values: (mcarray)
@@ -764,15 +764,15 @@ Thus, to conform to protocol, each entry under the ``fields`` section must be an
764764
* Material-Dependent Fields:
765765

766766
* fields/field/association: "vertex" | "element"
767-
* fields/field/grid_function: (mfem-style finite element collection name) (replaces "association")
767+
* fields/field/basis: (mfem-style finite element collection name) (replaces "association")
768768
* fields/field/volume_dependent: "true" | "false"
769769
* fields/field/matset: "matset"
770770
* fields/field/matset_values: (mcarray)
771771

772772
* Mixed Fields:
773773

774774
* fields/field/association: "vertex" | "element"
775-
* fields/field/grid_function: (mfem-style finite element collection name) (replaces "association")
775+
* fields/field/basis: (mfem-style finite element collection name) (replaces "association")
776776
* fields/field/volume_dependent: "true" | "false"
777777
* fields/field/topology: "topo"
778778
* fields/field/values: (mcarray)
@@ -1037,7 +1037,7 @@ To conform, the ``state`` entry must be an *Object* and can have the following o
10371037

10381038

10391039
Mesh Index Protocol
1040-
~~~~~~~~~~~~~~~~~~~~
1040+
++++++++++++++++++++++++
10411041

10421042
It is common for Blueprint data files to represent meshes that have been partitioned and must later be treated as a whole. Blueprint root files contain an index that facilitates reading in many individual Blueprint files. Blueprint root files contain metadata about the overall contents of individual files as well as hints for constructing filenames that make up the whole Blueprint dataset. An analysis tool can load the root file and know which individual files comprise the dataset and information about the data contained therein. While Blueprint provides high level functions for saving and loading files, some of which automatically create the root file, it is sometimes necessary to know the structure.
10431043

0 commit comments

Comments
 (0)