Unverified Commit c139898f authored by Axel Kohlmeyer's avatar Axel Kohlmeyer
Browse files

Convert a first set of AtC documentation html files to rst and add infrastructure files and links

parent fa7085be
Loading
Loading
Loading
Loading
+1 −0
Original line number Diff line number Diff line
@@ -72,6 +72,7 @@ every LAMMPS command.
   angles
   dihedrals
   impropers
   fix_modify_atc_commands

Indices and tables
==================
+46 −0
Original line number Diff line number Diff line
.. index:: fix_modify AtC mesh create

fix_modify AtC mesh create command
===================================

Syntax
""""""

.. parsed-literal::

   fix_modify <AtC fixID> mesh create <nx> <ny> <nz> <region-ID> <f|p> <f|p> <f|p>

* AtC fixID = ID of :doc:`fix atc <fix_atc>` instance
* mesh create = name of the AtC sub-command
* nx ny nz = number of elements in x-, y-, and z-direction
* region-ID = ID of region that is to be meshed
* f or p = periodicity flags for x-, y-, and z-direction

Examples
""""""""

.. code-block:: LAMMPS

   fix_modify AtC mesh create 10 1 1 feRegion p p p

Description
"""""""""""

Creates a uniform mesh in a rectangular region.

Restrictions
""""""""""""

Creates only uniform rectangular grids in a rectangular region

Related AtC commands
""""""""""""""""""""

:doc:`fix_modify AtC mesh quadrature <atc_mesh_quadrature>`

Default
"""""""

When created, the mesh defaults to gauss2 (2-point Gaussian)
quadrature. Use the :doc:`fix_modify AtC mesh quadrature
<atc_mesh_quadrature>` command to change the quadrature style.
+45 −0
Original line number Diff line number Diff line
.. index:: fix_modify AtC mesh create_nodeset

fix_modify AtC mesh create_nodeset command
==========================================

Syntax
""""""

.. parsed-literal::

   fix_modify <AtC fixID> mesh create_nodeset <id> <xmin> <xmax> <ymin> <ymax> <zmin> <zmax>

* AtC fixID = ID of :doc:`fix atc <fix_atc>` instance
* mesh create\_nodeset = name of the AtC sub-command
* id = id to assign to the collection of FE nodes
* <xmin> <xmax> <ymin> <ymax> <zmin> <zmax> = coordinates of the bounding box that contains only the desired nodes

Examples
""""""""

.. code-block:: LAMMPS

   fix_modify AtC mesh create_nodeset lbc -12.1 -11.9 -12 12 -12 12

Description
"""""""""""

Command to assign an id to a set of FE nodes to be used subsequently in
defining boundary conditions.

Restrictions
""""""""""""

None

Related AtC commands
""""""""""""""""""""

:doc:`fix_modify AtC mesh create <atc_mesh_create>`
:doc:`fix_modify AtC mesh read <atc_mesh_read>`

Default
"""""""

Coordinates are assumed to be in lattice units.
+44 −0
Original line number Diff line number Diff line
.. index:: fix_modify AtC mesh quadrature

fix_modify AtC mesh quadrature command
======================================

Syntax
""""""

.. parsed-literal::

   fix_modify <AtC fixID> mesh quatrature <quad>

* AtC fixID = ID of :doc:`fix atc <fix_atc>` instance
* mesh quadrature = name of the AtC sub-command
* quad = *nodal* or *gauss1* or *gauss2* or *gauss3* or *face*

Examples
""""""""

.. code-block:: LAMMPS

   fix_modify AtC mesh quadrature face

Description
"""""""""""

(Re-)assigns the quadrature style for an existing mesh.  When a mesh is
created its quadrature method defaults to gauss2.  Use this call to
change it after the fact.

Restrictions
""""""""""""

None.

Related AtC commands
""""""""""""""""""""

:doc:`fix_modify AtC mesh create <atc_mesh_create>`

Default
"""""""

None.
+46 −0
Original line number Diff line number Diff line
.. index:: fix_modify AtC mesh read

fix_modify AtC mesh read command
===================================

Syntax
""""""

.. parsed-literal::

   fix_modify <AtC fixID> mesh read <f|p> <f|p> <f|p>

* AtC fixID = ID of :doc:`fix atc <fix_atc>` instance
* mesh read = name of the AtC sub-command
* filename = name of the file containing the mesh to be read
* f or p = periodicity flags for x-, y-, and z-direction (optional)

Examples
""""""""

.. code-block:: LAMMPS

   fix_modify AtC mesh read myComponent.mesh p p p
   fix_modify AtC mesh read myOtherComponent.exo

Description
"""""""""""

Reads a mesh from a text or exodus file, and assigns periodic boundary
conditions if needed.

Restrictions
""""""""""""

None

Related AtC commands
""""""""""""""""""""

:doc:`fix_modify AtC mesh create <atc_mesh_create>`
:doc:`fix_modify AtC mesh write <atc_mesh_write>`

Default
"""""""

Periodicity flags are set to false (f) by default.
Loading