add reference to the fix_modify command overview in fix atc docs into all atc subcommand docs

This commit is contained in:
Axel Kohlmeyer
2020-03-13 11:06:11 -04:00
parent 5a81f69495
commit 80d413b86c
29 changed files with 117 additions and 18 deletions

View File

@ -35,6 +35,11 @@ Restrictions
Cannot change map type after initialization. Cannot change map type after initialization.
Related AtC commands
""""""""""""""""""""
- :ref:`fix_modify AtC command overview <atc_fix_modify>`
Default Default
""""""" """""""

View File

@ -34,6 +34,11 @@ Restrictions
None. None.
Related AtC commands
""""""""""""""""""""
- :ref:`fix_modify AtC command overview <atc_fix_modify>`
Default Default
""""""" """""""

View File

@ -0,0 +1,46 @@
.. index:: fix_modify AtC control localized_lambda
fix_modify AtC control localized_lambda command
===============================================
Syntax
""""""
.. parsed-literal::
fix_modify <AtC fixID> control localized_lambda <on|off>
* AtC fixID = ID of :doc:`fix atc <fix_atc>` instance
* control localized_lambda = name of the AtC sub-command
* *on* or *off* = Toggles state of localization algorithm
Examples
""""""""
.. code-block:: LAMMPS
fix_modify AtC control localized_lambda on
Description
"""""""""""
Turns the localization algorithms *on* or *off* for control algorithms
to restrict the influence of FE coupling or boundary conditions to a
region near the boundary of the MD region. Control algorithms will not
affect atoms in elements not possessing faces on the boundary of the
region. Flux-based control is localized via row-sum lumping while
quantity control is done by solving a truncated matrix equation.
Restrictions
""""""""""""
None.
Related AtC commands
""""""""""""""""""""
- :ref:`fix_modify AtC command overview <atc_fix_modify>`
Default
"""""""
off

View File

@ -68,7 +68,8 @@ They are ignored if a lumped solution is requested.
Related AtC commands Related AtC commands
"""""""""""""""""""" """"""""""""""""""""
:doc:`fix_modify AtC control thermal <atc_control_thermal>` - :ref:`fix_modify AtC command overview <atc_fix_modify>`
- :doc:`fix_modify AtC control thermal <atc_control_thermal>`
Default Default
""""""" """""""

View File

@ -75,7 +75,8 @@ the fractional step method.
Related AtC commands Related AtC commands
"""""""""""""""""""" """"""""""""""""""""
:doc:`fix_modify AtC control momentum <atc_control_momentum>` - :ref:`fix_modify AtC command overview <atc_fix_modify>`
- :doc:`fix_modify AtC control momentum <atc_control_momentum>`
Default Default
""""""" """""""

View File

@ -37,6 +37,11 @@ Restrictions
None. None.
Related AtC commands
""""""""""""""""""""
- :ref:`fix_modify AtC command overview <atc_fix_modify>`
Default Default
""""""" """""""

View File

@ -38,6 +38,11 @@ Restrictions
For use only with the two_temperature type of the AtC fix (see For use only with the two_temperature type of the AtC fix (see
:doc:`fix atc <fix_atc>` command) :doc:`fix atc <fix_atc>` command)
Related AtC commands
""""""""""""""""""""
- :ref:`fix_modify AtC command overview <atc_fix_modify>`
Default Default
""""""" """""""

View File

@ -37,7 +37,8 @@ The keyword *all* is reserved and thus not available as nodeset name.
Related AtC commands Related AtC commands
"""""""""""""""""""" """"""""""""""""""""
:doc:`fix_modify AtC unfix <atc_unfix>` - :ref:`fix_modify AtC command overview <atc_fix_modify>`
- :doc:`fix_modify AtC unfix <atc_unfix>`
Default Default
""""""" """""""

View File

@ -39,7 +39,8 @@ Only normal fluxes (Neumann data) can be prescribed.
Related AtC commands Related AtC commands
"""""""""""""""""""" """"""""""""""""""""
:doc:`fix_modify AtC unfix_flux <atc_unfix_flux>` - :ref:`fix_modify AtC command overview <atc_fix_modify>`
- :doc:`fix_modify AtC unfix_flux <atc_unfix_flux>`
Default Default
""""""" """""""

View File

@ -33,6 +33,11 @@ Restrictions
The keyword *all* is reserved and thus not available as nodeset name. The keyword *all* is reserved and thus not available as nodeset name.
Related AtC commands
""""""""""""""""""""
- :ref:`fix_modify AtC command overview <atc_fix_modify>`
Default Default
""""""" """""""

View File

@ -42,6 +42,7 @@ reneighbor frequency.
Related AtC commands Related AtC commands
"""""""""""""""""""" """"""""""""""""""""
- :ref:`fix_modify AtC command overview <atc_fix_modify>`
- :doc:`fix_modify AtC atom_element_map <atc_atom_element_map>` - :doc:`fix_modify AtC atom_element_map <atc_atom_element_map>`
- :doc:`fix_modify AtC boundary type <atc_boundary_type>` - :doc:`fix_modify AtC boundary type <atc_boundary_type>`

View File

@ -35,6 +35,11 @@ Optional region tag specifies which finite element nodes will be treated
as being within the MD region. This option is only valid with as being within the MD region. This option is only valid with
internal_quadrature off. internal_quadrature off.
Related AtC commands
""""""""""""""""""""
- :ref:`fix_modify AtC command overview <atc_fix_modify>`
Default Default
""""""" """""""

View File

@ -35,7 +35,8 @@ None
Related AtC commands Related AtC commands
"""""""""""""""""""" """"""""""""""""""""
:doc:`fix_modify AtC mesh create_nodeset <atc_mesh_create_nodeset>` - :ref:`fix_modify AtC command overview <atc_fix_modify>`
- :doc:`fix_modify AtC mesh create_nodeset <atc_mesh_create_nodeset>`
Default Default

View File

@ -36,7 +36,8 @@ Creates only uniform rectangular grids in a rectangular region
Related AtC commands Related AtC commands
"""""""""""""""""""" """"""""""""""""""""
:doc:`fix_modify AtC mesh quadrature <atc_mesh_quadrature>` - :ref:`fix_modify AtC command overview <atc_fix_modify>`
- :doc:`fix_modify AtC mesh quadrature <atc_mesh_quadrature>`
Default Default
""""""" """""""

View File

@ -36,6 +36,7 @@ Only viable for rectangular grids.
Related AtC commands Related AtC commands
"""""""""""""""""""" """"""""""""""""""""
- :ref:`fix_modify AtC command overview <atc_fix_modify>`
- :doc:`fix_modify AtC mesh delete_elements <atc_mesh_delete_elements>` - :doc:`fix_modify AtC mesh delete_elements <atc_mesh_delete_elements>`
- :doc:`fix_modify AtC mesh nodeset_to_elementset <atc_mesh_nodeset_to_elementset>` - :doc:`fix_modify AtC mesh nodeset_to_elementset <atc_mesh_nodeset_to_elementset>`

View File

@ -40,7 +40,8 @@ Only viable for rectangular grids.
Related AtC commands Related AtC commands
"""""""""""""""""""" """"""""""""""""""""
:doc:`fix_modify AtC mesh create_faceset plane <atc_mesh_create_faceset_plane>` - :ref:`fix_modify AtC command overview <atc_fix_modify>`
- :doc:`fix_modify AtC mesh create_faceset plane <atc_mesh_create_faceset_plane>`
Default Default
""""""" """""""

View File

@ -39,7 +39,8 @@ Only viable for rectangular grids.
Related AtC commands Related AtC commands
"""""""""""""""""""" """"""""""""""""""""
:doc:`fix_modify AtC mesh create_faceset box <atc_mesh_create_faceset_box>` - :ref:`fix_modify AtC command overview <atc_fix_modify>`
- :doc:`fix_modify AtC mesh create_faceset box <atc_mesh_create_faceset_box>`
Default Default
""""""" """""""

View File

@ -36,7 +36,8 @@ None
Related AtC commands Related AtC commands
"""""""""""""""""""" """"""""""""""""""""
:doc:`fix_modify AtC mesh add_to_nodeset <atc_mesh_add_to_nodeset>` - :ref:`fix_modify AtC command overview <atc_fix_modify>`
- :doc:`fix_modify AtC mesh add_to_nodeset <atc_mesh_add_to_nodeset>`
Default Default
""""""" """""""

View File

@ -34,6 +34,7 @@ None.
Related AtC commands Related AtC commands
"""""""""""""""""""" """"""""""""""""""""
- :ref:`fix_modify AtC command overview <atc_fix_modify>`
- :doc:`fix_modify AtC mesh create_elementset <atc_mesh_create_elementset>` - :doc:`fix_modify AtC mesh create_elementset <atc_mesh_create_elementset>`
- :doc:`fix_modify AtC mesh nodeset_to_elementset <atc_mesh_nodeset_to_elementset>` - :doc:`fix_modify AtC mesh nodeset_to_elementset <atc_mesh_nodeset_to_elementset>`

View File

@ -40,6 +40,7 @@ None.
Related AtC commands Related AtC commands
"""""""""""""""""""" """"""""""""""""""""
- :ref:`fix_modify AtC command overview <atc_fix_modify>`
- :doc:`fix_modify AtC mesh create_elementset <atc_mesh_create_elementset>` - :doc:`fix_modify AtC mesh create_elementset <atc_mesh_create_elementset>`
- :doc:`fix_modify AtC mesh delete_elements <atc_mesh_delete_elements>` - :doc:`fix_modify AtC mesh delete_elements <atc_mesh_delete_elements>`

View File

@ -36,7 +36,8 @@ None.
Related AtC commands Related AtC commands
"""""""""""""""""""" """"""""""""""""""""
:doc:`fix_modify AtC mesh create <atc_mesh_create>` - :ref:`fix_modify AtC command overview <atc_fix_modify>`
- :doc:`fix_modify AtC mesh create <atc_mesh_create>`
Default Default
""""""" """""""

View File

@ -37,6 +37,7 @@ None
Related AtC commands Related AtC commands
"""""""""""""""""""" """"""""""""""""""""
- :ref:`fix_modify AtC command overview <atc_fix_modify>`
- :doc:`fix_modify AtC mesh create <atc_mesh_create>` - :doc:`fix_modify AtC mesh create <atc_mesh_create>`
- :doc:`fix_modify AtC mesh write <atc_mesh_write>` - :doc:`fix_modify AtC mesh write <atc_mesh_write>`

View File

@ -34,6 +34,7 @@ None
Related AtC commands Related AtC commands
"""""""""""""""""""" """"""""""""""""""""
- :ref:`fix_modify AtC command overview <atc_fix_modify>`
- :doc:`fix_modify AtC mesh create <atc_mesh_create>` - :doc:`fix_modify AtC mesh create <atc_mesh_create>`
- :doc:`fix_modify AtC mesh read <atc_mesh_read>` - :doc:`fix_modify AtC mesh read <atc_mesh_read>`

View File

@ -35,7 +35,8 @@ The keyword *all* is reserved and thus not available as element_set name.
Related AtC commands Related AtC commands
"""""""""""""""""""" """"""""""""""""""""
:doc:`fix_modify AtC source <atc_source>` - :ref:`fix_modify AtC command overview <atc_fix_modify>`
- :doc:`fix_modify AtC source <atc_source>`
Default Default
""""""" """""""

View File

@ -39,7 +39,8 @@ The keyword *all* is reserved and thus not available as element_set name.
Related AtC commands Related AtC commands
"""""""""""""""""""" """"""""""""""""""""
:doc:`fix_modify AtC remove_source <atc_remove_source>` - :ref:`fix_modify AtC command overview <atc_fix_modify>`
- :doc:`fix_modify AtC remove_source <atc_remove_source>`
Default Default
""""""" """""""

View File

@ -66,10 +66,11 @@ Restrictions
None. None.
Related commands
""""""""""""""""
:doc:`fix atc <fix_atc>` Related AtC commands
""""""""""""""""""""
- :ref:`fix_modify AtC command overview <atc_fix_modify>`
Default Default
""""""" """""""

View File

@ -35,7 +35,8 @@ The keyword *all* is reserved and thus not available as nodeset name.
Related AtC commands Related AtC commands
"""""""""""""""""""" """"""""""""""""""""
:doc:`fix_modify AtC fix <atc_fix>` - :ref:`fix_modify AtC command overview <atc_fix_modify>`
- :doc:`fix_modify AtC fix <atc_fix>`
Default Default
""""""" """""""

View File

@ -36,7 +36,8 @@ None.
Related AtC commands Related AtC commands
"""""""""""""""""""" """"""""""""""""""""
:doc:`fix_modify AtC fix_flux <atc_fix_flux>` - :ref:`fix_modify AtC command overview <atc_fix_modify>`
- :doc:`fix_modify AtC fix_flux <atc_fix_flux>`
Default Default
""""""" """""""

View File

@ -139,6 +139,8 @@ one, e.g. nve, nvt, etc. In addition, currently:
* the coupling is restricted to thermal physics * the coupling is restricted to thermal physics
* the FE computations are done in serial on each processor. * the FE computations are done in serial on each processor.
.. _atc_fix_modify:
Related commands Related commands
"""""""""""""""" """"""""""""""""
@ -181,7 +183,7 @@ conditions.
* :doc:`fix_modify AtC control thermal <atc_control_thermal>` * :doc:`fix_modify AtC control thermal <atc_control_thermal>`
* :doc:`fix_modify AtC control momentum <atc_control_momentum>` * :doc:`fix_modify AtC control momentum <atc_control_momentum>`
* `fix_modify AtC control localized_lambda <USER/atc/man_localized_lambda.html>`_ * :doc:`fix_modify AtC control localized_lambda <atc_control_localized_lambda>`
* `fix_modify AtC control lumped_lambda_solve <USER/atc/man_lumped_lambda_solve.html>`_ * `fix_modify AtC control lumped_lambda_solve <USER/atc/man_lumped_lambda_solve.html>`_
* `fix_modify AtC control mask_direction <USER/atc/man_mask_direction.html>`_ control * `fix_modify AtC control mask_direction <USER/atc/man_mask_direction.html>`_ control
* `fix_modify AtC filter <USER/atc/man_time_filter.html>`_ * `fix_modify AtC filter <USER/atc/man_time_filter.html>`_