ESPResSo
Extensible Simulation Package for Research on Soft Matter Systems
Loading...
Searching...
No Matches
rigid_bond.hpp
Go to the documentation of this file.
1/*
2 * Copyright (C) 2010-2022 The ESPResSo project
3 * Copyright (C) 2002,2003,2004,2005,2006,2007,2008,2009,2010
4 * Max-Planck-Institute for Polymer Research, Theory Group
5 *
6 * This file is part of ESPResSo.
7 *
8 * ESPResSo is free software: you can redistribute it and/or modify
9 * it under the terms of the GNU General Public License as published by
10 * the Free Software Foundation, either version 3 of the License, or
11 * (at your option) any later version.
12 *
13 * ESPResSo is distributed in the hope that it will be useful,
14 * but WITHOUT ANY WARRANTY; without even the implied warranty of
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 * GNU General Public License for more details.
17 *
18 * You should have received a copy of the GNU General Public License
19 * along with this program. If not, see <http://www.gnu.org/licenses/>.
20 */
21
22#pragma once
23
24/** \file
25 * Definition of the rigid bond data type for the Rattle algorithm.
26 */
27
28#include <utils/Vector.hpp>
29
30#include <cmath>
31
32/** Parameters for the rigid_bond/SHAKE/RATTLE ALGORITHM */
33struct RigidBond {
34 /** Square of the length of Constrained Bond */
35 double d2;
36 /** Positional Tolerance/Accuracy value for termination of RATTLE/SHAKE
37 * iterations during position corrections
38 */
39 double p_tol;
40 /** Velocity Tolerance/Accuracy for termination of RATTLE/SHAKE iterations
41 * during velocity corrections
42 */
43 double v_tol;
44
45 double cutoff() const { return std::sqrt(d2); }
46
47 static constexpr int num = 1;
48
49 RigidBond(double d, double p_tol, double v_tol) {
50 this->d2 = d * d;
51 this->p_tol = 2.0 * p_tol;
52 this->v_tol = v_tol;
53 }
54};
Vector implementation and trait types for boost qvm interoperability.
Parameters for the rigid_bond/SHAKE/RATTLE ALGORITHM.
double d2
Square of the length of Constrained Bond.
double v_tol
Velocity Tolerance/Accuracy for termination of RATTLE/SHAKE iterations during velocity corrections.
double cutoff() const
RigidBond(double d, double p_tol, double v_tol)
double p_tol
Positional Tolerance/Accuracy value for termination of RATTLE/SHAKE iterations during position correc...
static constexpr int num