Skip to content

Fix UniformLennardJones, GlobalForceField and FlexibleLocalDihedral doc #323

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
yutakasi634 wants to merge 8 commits into
base: master
Choose a base branch
from
Open

Fix UniformLennardJones, GlobalForceField and FlexibleLocalDihedral doc #323

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
470c754
Merge branch 'develop' of https://github.com/Mjolnir-MD/Mjolnir
yutakasi634 Jan 18, 2021
640edc1
Merge branch 'master' of https://github.com/Mjolnir-MD/Mjolnir
yutakasi634 Feb 16, 2021
83b7be9
Merge branch 'master' of https://github.com/Mjolnir-MD/Mjolnir
yutakasi634 Mar 16, 2021
868731e
Merge branch 'master' of https://github.com/Mjolnir-MD/Mjolnir
yutakasi634 May 13, 2021
413fed6
Merge branch 'master' of https://github.com/Mjolnir-MD/Mjolnir
yutakasi634 Mar 17, 2022
e6b5af9
doc: fix typo in UniformLennardJonesPotential.md
yutakasi634 Apr 14, 2022
bab2e65
doc: fix link in GlobalForceField
yutakasi634 Apr 12, 2022
642257b
doc: fix order of parameter for FLD
yutakasi634 Jan 27, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions book/content.en/docs/reference/forcefields/global/_index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,11 +12,11 @@ bookCollapseSection = true

It depends on the distances between two particles.

## [3SPN2BaseBase](3SPN2BaseBaseInteraction.md)
## [3SPN2BaseBase]({{<relref "3SPN2BaseBaseInteraction.md">}})

It is specific to 3SPN2 Coarse-Grained DNA model.

## [ProteinDNANonSpecific](ProteinDNANonSpecificInteraction.md)
## [ProteinDNANonSpecific]({{<relref "ProteinDNANonSpecificInteraction.md">}})

It is a Coarse-Grained hydrogen bond model.

Expand Down
2 changes: 1 addition & 1 deletion ...ntent.en/docs/reference/forcefields/global/pair/UniformLennardJonesPotential.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ parameters = [
- The cutoff distance relative to the maximum {{<katex>}}\sigma_{ij}{{</katex>}}.
- `index`: Integer
- The index of the particle.
- `offset`: Integer (ptional. By default, 0.)
- `offset`: Integer (optional. By default, 0.)
- Offset of the index.
- `sigma`: Floating
- It determines the effective particle size.
Expand Down
2 changes: 1 addition & 1 deletion ....en/docs/reference/forcefields/local/dihedral/FlexibleLocalDihedralPotential.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ parameters = [
- `k`: Floating
- It determines the strength of the potential.
- `coef`: Array of Floatings (length = 7)
- {{<katex>}} C, k_1^{\sin}, k_1^{\cos}, k_2^{\sin}, k_2^{\cos}, k_3^{\sin}, k_3^{\cos} {{</katex>}}, respectively.
- {{<katex>}} C, k_1^{\cos}, k_1^{\sin}, k_2^{\cos}, k_2^{\sin}, k_3^{\cos}, k_3^{\sin} {{</katex>}}, respectively.
- `indices`: Array of Integers (length = 4)
- Indices of particles that interact with each other. The index is 0-based.
- `offset`: Integer(Optional. By default, 0.)
Expand Down
2 changes: 1 addition & 1 deletion ....ja/docs/reference/forcefields/local/dihedral/FlexibleLocalDihedralPotential.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ parameters = [
- `k`: 浮動小数点数型
- このポテンシャルの強さを指定します。
- `coef`: 浮動小数点数の配列型（長さ: 7）
- 前から順に、{{<katex>}} C, k_1^{\sin}, k_1^{\cos}, k_2^{\sin}, k_2^{\cos}, k_3^{\sin}, k_3^{\cos} {{</katex>}}です。
- 前から順に、{{<katex>}} C, k_1^{\cos}, k_1^{\sin}, k_2^{\cos}, k_2^{\sin}, k_3^{\cos}, k_3^{\sin} {{</katex>}}です。
- `indices`: 整数の配列型（長さ: 4）
- どの粒子の間に適用するかを指定します。最初の粒子は0番めです。
- `offset`: 整数型（省略可能）
Expand Down