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

four more atc subcommand doc files converted

parent 0548dbc7
Loading
Loading
Loading
Loading
+43 −0
Original line number Diff line number Diff line
.. index:: fix_modify AtC decomposition

fix_modify AtC decomposition command
====================================

Syntax
""""""

.. parsed-literal::

   fix_modify <AtC fixID> decomposition <type>

* AtC fixID = ID of :doc:`fix atc <fix_atc>` instance
* decomposition = name of the AtC sub-command
* type =  *replicated_memory* or *distributed_memory*


Examples
""""""""

.. code-block:: LAMMPS

   fix_modify AtC decomposition distributed_memory

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

Command for assigning the distribution of work and memory for parallel
runs.  With *replicated_memory* the nodal information is replicated on
each processor, and with *distributed_memory* only the owned nodal
information kept on each processor.  The *replicated_memory* option
is most appropriate for simulations were the number of nodes is much
smaller than the number of atoms.

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

None.

Default
"""""""

replicated_memory

doc/src/atc_fix.rst

0 → 100644
+45 −0
Original line number Diff line number Diff line
.. index:: fix_modify AtC fix

fix_modify AtC initial command
==============================

Syntax
""""""

.. parsed-literal::

   fix_modify <AtC fixID> fix <field> <nodeset> <constant|function>

* AtC fixID = ID of :doc:`fix atc <fix_atc>` instance
* fix = name of the AtC sub-command
* field = field kind name valid for type of physics: *temperature* or *electron_temperature*
* nodeset = name of set of nodes to apply boundary condition
* *constant* or *function* = value or name of function followed by its parameters

Examples
""""""""

.. code-block:: LAMMPS

   fix_modify AtC fix temperature groupNAME 10.
   fix_modify AtC fix temperature groupNAME 0 0 0 10.0 0 0 1.0

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

Creates a constraint on the values of the specified field at specified nodes.

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

The keyword *all* is reserved and thus not available as nodeset name.

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

:doc:`fix_modify AtC unfix <atc_unfix>`

Default
"""""""

None.
+39 −0
Original line number Diff line number Diff line
.. index:: fix_modify AtC initial

fix_modify AtC initial command
====================================

Syntax
""""""

.. parsed-literal::

   fix_modify <AtC fixID> initial <field> <nodeset> <constant|function>

* AtC fixID = ID of :doc:`fix atc <fix_atc>` instance
* initial = name of the AtC sub-command
* field = field kind name valid for type of physics: *temperature* or *electron_temperature*
* nodeset = name of set of nodes to apply initial condition
* *constant* or *function* = value or name of function followed by its parameters

Examples
""""""""

.. code-block:: LAMMPS

   fix_modify atc initial temperature groupNAME 10.

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

Sets the initial values for the specified field at the specified nodes.

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

The keyword *all* is reserved and thus not available as nodeset name.

Default
"""""""

None.

doc/src/atc_unfix.rst

0 → 100644
+43 −0
Original line number Diff line number Diff line
.. index:: fix_modify AtC unfix

fix_modify AtC initial command
==============================

Syntax
""""""

.. parsed-literal::

   fix_modify <AtC fixID> unfix <field> <nodeset>

* AtC fixID = ID of :doc:`fix atc <fix_atc>` instance
* unfix = name of the AtC sub-command
* field = field kind name valid for type of physics: *temperature* or *electron_temperature*
* nodeset = name of set of nodes to apply boundary condition

Examples
""""""""

.. code-block:: LAMMPS

   fix_modify AtC unfix temperature groupNAME

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

Removes constraint on field values for specified nodes.

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

The keyword *all* is reserved and thus not available as nodeset name.

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

:doc:`fix_modify AtC fix <atc_fix>`

Default
"""""""

None.
+4 −4
Original line number Diff line number Diff line
@@ -165,13 +165,13 @@ conditions.
* :doc:`fix_modify AtC time_integration <atc_time_integration>`
* :doc:`fix_modify AtC extrinsic electron_integration <atc_electron_integration>`
* :doc:`fix_modify AtC internal_element_set <atc_internal_element_set>`
* `fix_modify AtC decomposition <USER/atc/man_decomposition.html>`_
* :doc:`fix_modify AtC decomposition <atc_decomposition>`

*fix_modify* commands for boundary and initial conditions:

* `fix_modify AtC initial <USER/atc/man_initial.html>`_
* `fix_modify AtC fix <USER/atc/man_fix_nodes.html>`_
* `fix_modify AtC unfix <USER/atc/man_unfix_nodes.html>`_
* :doc:`fix_modify AtC initial <atc_initial>`
* :doc:`fix_modify AtC fix <atc_fix>`
* :doc:`fix_modify AtC unfix <atc_unfix>`
* `fix_modify AtC fix_flux <USER/atc/man_fix_flux.html>`_
* `fix_modify AtC unfix_flux <USER/atc/man_unfix_flux.html>`_
* `fix_modify AtC source <USER/atc/man_source.html>`_
Loading