From cbd8d07dafeb07b8f9a5a3061ddbcaa6f13a5278 Mon Sep 17 00:00:00 2001 From: Axel Kohlmeyer Date: Thu, 12 Mar 2020 16:34:42 -0400 Subject: [PATCH] convert elementset AtC commands --- doc/src/atc_mesh_create_elementset.rst | 45 +++++++++++++++++++ doc/src/atc_mesh_delete_elements.rst | 43 ++++++++++++++++++ doc/src/atc_mesh_nodeset_to_elementset.rst | 49 +++++++++++++++++++++ doc/src/fix_atc.rst | 6 +-- doc/utils/sphinx-config/false_positives.txt | 1 + 5 files changed, 141 insertions(+), 3 deletions(-) create mode 100644 doc/src/atc_mesh_create_elementset.rst create mode 100644 doc/src/atc_mesh_delete_elements.rst create mode 100644 doc/src/atc_mesh_nodeset_to_elementset.rst diff --git a/doc/src/atc_mesh_create_elementset.rst b/doc/src/atc_mesh_create_elementset.rst new file mode 100644 index 0000000000..f657198751 --- /dev/null +++ b/doc/src/atc_mesh_create_elementset.rst @@ -0,0 +1,45 @@ +.. index:: fix_modify AtC mesh create_elementset + +fix_modify AtC mesh create_elementset command +============================================= + +Syntax +"""""" + +.. parsed-literal:: + + fix_modify mesh create_elementset + +* AtC fixID = ID of :doc:`fix atc ` instance +* mesh create\_elementset = name of the AtC sub-command +* id = id to assign to the collection of FE nodes +* = coordinates of the bounding box that contains only the desired elements + +Examples +"""""""" + +.. code-block:: LAMMPS + + fix_modify AtC mesh create_elementset middle -4.1 4.1 -100 100 -100 1100 + +Description +""""""""""" + +Command to assign an id to a set of FE elements to be used subsequently +in defining material and mesh-based operations. + +Restrictions +"""""""""""" + +Only viable for rectangular grids. + +Related AtC commands +"""""""""""""""""""" + +:doc:`fix_modify AtC mesh delete_elements ` +:doc:`fix_modify AtC mesh nodeset_to_elementset ` + +Default +""""""" + +Coordinates are assumed to be in lattice units. diff --git a/doc/src/atc_mesh_delete_elements.rst b/doc/src/atc_mesh_delete_elements.rst new file mode 100644 index 0000000000..c7f86abfd6 --- /dev/null +++ b/doc/src/atc_mesh_delete_elements.rst @@ -0,0 +1,43 @@ +.. index:: fix_modify AtC mesh delete_elements + +fix_modify AtC mesh delete_elements command +============================================= + +Syntax +"""""" + +.. parsed-literal:: + + fix_modify mesh delete_elements + +* AtC fixID = ID of :doc:`fix atc ` instance +* mesh create\_elementset = name of the AtC sub-command +* id = id of the element set + +Examples +"""""""" + +.. code-block:: LAMMPS + + fix_modify AtC mesh delete_elements gap + +Description +""""""""""" + +Deletes a group of elements from the mesh. + +Restrictions +"""""""""""" + +None. + +Related AtC commands +"""""""""""""""""""" + +:doc:`fix_modify AtC mesh create_elementset ` +:doc:`fix_modify AtC mesh nodeset_to_elementset ` + +Default +""""""" + +None. diff --git a/doc/src/atc_mesh_nodeset_to_elementset.rst b/doc/src/atc_mesh_nodeset_to_elementset.rst new file mode 100644 index 0000000000..0df933aaeb --- /dev/null +++ b/doc/src/atc_mesh_nodeset_to_elementset.rst @@ -0,0 +1,49 @@ +.. index:: fix_modify AtC mesh nodeset_to_elementset + +fix_modify AtC mesh nodeset_to_elementset command +================================================= + +Syntax +"""""" + +.. parsed-literal:: + + fix_modify mesh nodeset_to_elementset + +* AtC fixID = ID of :doc:`fix atc ` instance +* mesh nodeset\_to\_elementset = name of the AtC sub-command +* nodeset\_id = id of desired nodeset from which to create the elementset +* elementset\_id = id to assign to the collection of FE elements +* = flag to choose either the maximal or minimal elementset + +Examples +"""""""" + +.. code-block:: LAMMPS + + fix_modify AtC mesh nodeset_to_elementset myNodeset myElementset min + + +Description +""""""""""" + +Command to create an elementset from an existing nodeset. Either the +minimal element set of elements with all nodes in the set, or maximal +element set with all elements with at least one node in the set, can be +created. + +Restrictions +"""""""""""" + +None. + +Related AtC commands +"""""""""""""""""""" + +:doc:`fix_modify AtC mesh create_elementset ` +:doc:`fix_modify AtC mesh delete_elements ` + +Default +""""""" + +Unless specified, the maximal element set is created. diff --git a/doc/src/fix_atc.rst b/doc/src/fix_atc.rst index 165dad223d..0798dbc033 100644 --- a/doc/src/fix_atc.rst +++ b/doc/src/fix_atc.rst @@ -157,9 +157,9 @@ conditions. * :doc:`fix_modify AtC mesh add_to_nodeset ` * :doc:`fix_modify AtC mesh create_faceset box ` * :doc:`fix_modify AtC mesh create_faceset plane ` -* `fix_modify AtC mesh create_elementset `_ -* `fix_modify AtC mesh delete_elements `_ -* `fix_modify AtC mesh nodeset_to_elementset `_ +* :doc:`fix_modify AtC mesh create_elementset ` +* :doc:`fix_modify AtC mesh delete_elements ` +* :doc:`fix_modify AtC mesh nodeset_to_elementset ` * `fix_modify AtC boundary `_ * `fix_modify AtC internal_quadrature `_ * `fix_modify AtC time_integration (thermal) `_ diff --git a/doc/utils/sphinx-config/false_positives.txt b/doc/utils/sphinx-config/false_positives.txt index a28b82212f..61c8b3ab70 100644 --- a/doc/utils/sphinx-config/false_positives.txt +++ b/doc/utils/sphinx-config/false_positives.txt @@ -746,6 +746,7 @@ electronegative electronegativity Eleftheriou ElementN +elementset elif Elj Ellad