Merge pull request #60 from evoyiatzis/patch-1

Update compute.txt with missing one line comments on compute commands

doc/src/compute.txt

@@ -171,42 +171,40 @@ The individual style names on the "Commands
 compute"_Commands_compute.html doc page are followed by one or more of
 (g,i,k,o,t) to indicate which accelerated styles exist.
 
-"ackland/atom"_compute_ackland_atom.html -
+"ackland/atom"_compute_ackland_atom.html - determines the local lattice structure based on the Ackland formulation
 "adf"_compute_adf.html - angular distribution function of triples of atoms
 "aggregate/atom"_compute_cluster_atom.html - aggregate ID for each atom
-"angle"_compute_angle.html -
+"angle"_compute_angle.html - energy of each angle sub-style
-"angle/local"_compute_angle_local.html -
+"angle/local"_compute_angle_local.html - theta and energy of each angle
-"angle/local"_compute_bond_local.html - theta and energy of each angle
 "angmom/chunk"_compute_angmom_chunk.html - angular momentum for each chunk
-"basal/atom"_compute_basal_atom.html -
+"basal/atom"_compute_basal_atom.html - calculates the hexagonal close-packed “c” lattice vector of each atom
 "body/local"_compute_body_local.html - attributes of body sub-particles
-"bond"_compute_bond.html - values computed by a bond style
+"bond"_compute_bond.html - energy of each bond sub-style
 "bond/local"_compute_bond_local.html - distance and energy of each bond
 "centro/atom"_compute_centro_atom.html - centro-symmetry parameter for each atom
 "chunk/atom"_compute_chunk_atom.html - assign chunk IDs to each atom
 "chunk/spread/atom"_compute_chunk_spread_atom.html - spreads chunk values to each atom in chunk
 "cluster/atom"_compute_cluster_atom.html - cluster ID for each atom
 "cna/atom"_compute_cna_atom.html - common neighbor analysis (CNA) for each atom
-"cnp/atom"_compute_cnp_atom.html -
+"cnp/atom"_compute_cnp_atom.html - common neighborhood parameter (CNP) for each atom
 "com"_compute_com.html - center-of-mass of group of atoms
 "com/chunk"_compute_com_chunk.html - center-of-mass for each chunk
 "contact/atom"_compute_contact_atom.html - contact count for each spherical particle
 "coord/atom"_compute_coord_atom.html - coordination number for each atom
 "damage/atom"_compute_damage_atom.html - Peridynamic damage for each atom
-"dihedral"_compute_dihedral.html -
+"dihedral"_compute_dihedral.html - energy of each dihedral sub-style
 "dihedral/local"_compute_dihedral_local.html - angle of each dihedral
 "dilatation/atom"_compute_dilatation_atom.html - Peridynamic dilatation for each atom
-"dipole/chunk"_compute_dipole_chunk.html -
+"dipole/chunk"_compute_dipole_chunk.html - dipole vector and total dipole for each chunk
 "displace/atom"_compute_displace_atom.html - displacement of each atom
 "dpd"_compute_dpd.html -
 "dpd/atom"_compute_dpd_atom.html -
-"edpd/temp/atom"_compute_edpd_temp_atom.html -
+"edpd/temp/atom"_compute_edpd_temp_atom.html - per-atom temperature for each eDPD particle in a group
-"entropy/atom"_compute_entropy_atom.html -
+"entropy/atom"_compute_entropy_atom.html - pair entropy fingerprint of each atom
 "erotate/asphere"_compute_erotate_asphere.html - rotational energy of aspherical particles
 "erotate/rigid"_compute_erotate_rigid.html - rotational energy of rigid bodies
 "erotate/sphere"_compute_erotate_sphere.html - rotational energy of spherical particles
-"erotate/sphere/atom"_compute_erotate_sphere.html - rotational energy for each spherical particle
+"erotate/sphere/atom"_compute_erotate_sphere_atom.html - rotational energy for each spherical particle
-"erotate/sphere/atom"_compute_erotate_sphere_atom.html -
 "event/displace"_compute_event_displace.html - detect event on atom displacement
 "fep"_compute_fep.html -
 "force/tally"_compute_tally.html -
@@ -218,17 +216,17 @@ compute"_Commands_compute.html doc page are followed by one or more of
 "heat/flux"_compute_heat_flux.html - heat flux through a group of atoms
 "heat/flux/tally"_compute_tally.html -
 "hexorder/atom"_compute_hexorder_atom.html - bond orientational order parameter q6
-"improper"_compute_improper.html -
+"improper"_compute_improper.html - energy of each improper sub-style
 "improper/local"_compute_improper_local.html - angle of each improper
 "inertia/chunk"_compute_inertia_chunk.html - inertia tensor for each chunk
 "ke"_compute_ke.html - translational kinetic energy
 "ke/atom"_compute_ke_atom.html - kinetic energy for each atom
-"ke/atom/eff"_compute_ke_atom_eff.html -
+"ke/atom/eff"_compute_ke_atom_eff.html - per-atom translational and radial kinetic energy in the electron force field model
-"ke/eff"_compute_ke_eff.html -
+"ke/eff"_compute_ke_eff.html - kinetic energy of a group of nuclei and electrons in the electron force field model
 "ke/rigid"_compute_ke_rigid.html - translational kinetic energy of rigid bodies
-"meso/e/atom"_compute_meso_e_atom.html -
+"meso/e/atom"_compute_meso_e_atom.html - per-atom internal energy of Smooth-Particle Hydrodynamics atoms
-"meso/rho/atom"_compute_meso_rho_atom.html -
+"meso/rho/atom"_compute_meso_rho_atom.html - per-atom mesoscopic density of Smooth-Particle Hydrodynamics atoms
-"meso/t/atom"_compute_meso_t_atom.html -
+"meso/t/atom"_compute_meso_t_atom.html - per-atom internal temperature of Smooth-Particle Hydrodynamics atoms
 "msd"_compute_msd.html - mean-squared displacement of group of atoms
 "msd/chunk"_compute_msd_chunk.html - mean-squared displacement for each chunk
 "msd/nongauss"_compute_msd_nongauss.html - MSD and non-Gaussian parameter of group of atoms
@@ -242,73 +240,72 @@ compute"_Commands_compute.html doc page are followed by one or more of
 "pe/tally"_compute_tally.html -
 "plasticity/atom"_compute_plasticity_atom.html - Peridynamic plasticity for each atom
 "pressure"_compute_pressure.html - total pressure and pressure tensor
-"pressure/cylinder"_compute_pressure_cylinder.html -
+"pressure/cylinder"_compute_pressure_cylinder.html - pressure tensor in cylindrical coordinates
-"pressure/uef"_compute_pressure_uef.html -
+"pressure/uef"_compute_pressure_uef.html - pressure tensor in the reference frame of an applied flow field 
 "property/atom"_compute_property_atom.html - convert atom attributes to per-atom vectors/arrays
 "property/chunk"_compute_property_chunk.html - extract various per-chunk attributes
 "property/local"_compute_property_local.html - convert local attributes to localvectors/arrays
-"ptm/atom"_compute_ptm_atom.html -
+"ptm/atom"_compute_ptm_atom.html - determines the local lattice structure based on the Polyhedral Template Matching method
 "rdf"_compute_rdf.html - radial distribution function g(r) histogram of group of atoms
 "reduce"_compute_reduce.html - combine per-atom quantities into a single global value
 "reduce/chunk"_compute_reduce_chunk.html - reduce per-atom quantities within each chunk
 "reduce/region"_compute_reduce.html - same as compute reduce, within a region
 "rigid/local"_compute_rigid_local.html - extract rigid body attributes
-"saed"_compute_saed.html -
+"saed"_compute_saed.html - electron diffraction intensity on a mesh of reciprocal lattice nodes
 "slice"_compute_slice.html - extract values from global vector or array
 "smd/contact/radius"_compute_smd_contact_radius.html -
-"smd/damage"_compute_smd_damage.html -
+"smd/damage"_compute_smd_damage.html - damage status of SPH particles in Smooth Mach Dynamics
 "smd/hourglass/error"_compute_smd_hourglass_error.html -
-"smd/internal/energy"_compute_smd_internal_energy.html -
+"smd/internal/energy"_compute_smd_internal_energy.html - per-particle enthalpy in Smooth Mach Dynamics
-"smd/plastic/strain"_compute_smd_plastic_strain.html -
+"smd/plastic/strain"_compute_smd_plastic_strain.html - equivalent plastic strain per particle in Smooth Mach Dynamics
-"smd/plastic/strain/rate"_compute_smd_plastic_strain_rate.html -
+"smd/plastic/strain/rate"_compute_smd_plastic_strain_rate.html - time rate of the equivalent plastic strain in Smooth Mach Dynamics
-"smd/rho"_compute_smd_rho.html -
+"smd/rho"_compute_smd_rho.html - per-particle mass density in Smooth Mach Dynamics
-"smd/tlsph/defgrad"_compute_smd_tlsph_defgrad.html -
+"smd/tlsph/defgrad"_compute_smd_tlsph_defgrad.html - deformation gradient in Smooth Mach Dynamics
-"smd/tlsph/dt"_compute_smd_tlsph_dt.html -
+"smd/tlsph/dt"_compute_smd_tlsph_dt.html - CFL-stable time increment per particle in Smooth Mach Dynamics
 "smd/tlsph/num/neighs"_compute_smd_tlsph_num_neighs.html -
 "smd/tlsph/shape"_compute_smd_tlsph_shape.html -
 "smd/tlsph/strain"_compute_smd_tlsph_strain.html -
 "smd/tlsph/strain/rate"_compute_smd_tlsph_strain_rate.html -
-"smd/tlsph/stress"_compute_smd_tlsph_stress.html -
+"smd/tlsph/stress"_compute_smd_tlsph_stress.html - per-particle Cauchy stress tensor for SPH particles
-"smd/triangle/vertices"_compute_smd_triangle_vertices.html -
 "smd/triangle/vertices"_compute_smd_triangle_vertices.html -
 "smd/ulsph/num/neighs"_compute_smd_ulsph_num_neighs.html -
 "smd/ulsph/strain"_compute_smd_ulsph_strain.html -
 "smd/ulsph/strain/rate"_compute_smd_ulsph_strain_rate.html -
-"smd/ulsph/stress"_compute_smd_ulsph_stress.html -
+"smd/ulsph/stress"_compute_smd_ulsph_stress.html - per-particle Cauchy stress tensor and von Mises equivalent stress in Smooth Mach Dynamics
-"smd/vol"_compute_smd_vol.html -
+"smd/vol"_compute_smd_vol.html - per-particle volumes and their sum in Smooth Mach Dynamics
 "sna/atom"_compute_sna_atom.html - calculate bispectrum coefficients for each atom
 "snad/atom"_compute_sna_atom.html - derivative of bispectrum coefficients for each atom
 "snav/atom"_compute_sna_atom.html - virial contribution from bispectrum coefficients for each atom
-"spin"_compute_spin.html -
+"spin"_compute_spin.html - magnetic quantities for a system of atoms having spins
 "stress/atom"_compute_stress_atom.html - stress tensor for each atom
-"stress/mop"_compute_stress_mop.html -
+"stress/mop"_compute_stress_mop.html - normal components of the local stress tensor using the method of planes
-"stress/mop/profile"_compute_stress_mop.html -
+"stress/mop/profile"_compute_stress_mop.html - profile of the normal components of the local stress tensor using the method of planes
 "stress/tally"_compute_tally.html -
-"tdpd/cc/atom"_compute_tdpd_cc_atom.html -
+"tdpd/cc/atom"_compute_tdpd_cc_atom.html - per-atom chemical concentration of a specified species for each tDPD particle 
 "temp"_compute_temp.html - temperature of group of atoms
 "temp/asphere"_compute_temp_asphere.html - temperature of aspherical particles
 "temp/body"_compute_temp_body.html - temperature of body particles
 "temp/chunk"_compute_temp_chunk.html - temperature of each chunk
 "temp/com"_compute_temp_com.html - temperature after subtracting center-of-mass velocity
-"temp/cs"_compute_temp_cs.html -
+"temp/cs"_compute_temp_cs.html - temperature based on the center-of-mass velocity of atom pairs that are bonded to each other
 "temp/deform"_compute_temp_deform.html - temperature excluding box deformation velocity
-"temp/deform/eff"_compute_temp_deform_eff.html -
+"temp/deform/eff"_compute_temp_deform_eff.html - temperature excluding box deformation velocity in the electron force field model
-"temp/drude"_compute_temp_drude.html -
+"temp/drude"_compute_temp_drude.html - temperature of Core-Drude pairs
-"temp/eff"_compute_temp_eff.html -
+"temp/eff"_compute_temp_eff.html - temperature of a group of nuclei and electrons in the electron force field model
 "temp/partial"_compute_temp_partial.html - temperature excluding one or more dimensions of velocity
 "temp/profile"_compute_temp_profile.html - temperature excluding a binned velocity profile
 "temp/ramp"_compute_temp_ramp.html - temperature excluding ramped velocity component
 "temp/region"_compute_temp_region.html - temperature of a region of atoms
-"temp/region/eff"_compute_temp_region_eff.html -
+"temp/region/eff"_compute_temp_region_eff.html - temperature of a region of nuclei and electrons in the electron force field model
-"temp/rotate"_compute_temp_rotate.html -
+"temp/rotate"_compute_temp_rotate.html - temperature of a group of atoms after subtracting out their center-of-mass and angular velocities
 "temp/sphere"_compute_temp_sphere.html - temperature of spherical particles
-"temp/uef"_compute_temp_uef.html -
+"temp/uef"_compute_temp_uef.html - kinetic energy tensor in the reference frame of an applied flow field
 "ti"_compute_ti.html - thermodynamic integration free energy values
 "torque/chunk"_compute_torque_chunk.html - torque applied on each chunk
 "vacf"_compute_vacf.html - velocity auto-correlation function of group of atoms
 "vcm/chunk"_compute_vcm_chunk.html - velocity of center-of-mass for each chunk
 "voronoi/atom"_compute_voronoi_atom.html - Voronoi volume and neighbors for each atom
-"xrd"_compute_xrd.html - :ul
+"xrd"_compute_xrd.html - x-ray diffraction intensity on a mesh of reciprocal lattice nodes :ul
 
 [Restrictions:] none