votca 2024.2-dev
Loading...
Searching...
No Matches
beadmotifalgorithms.h
Go to the documentation of this file.
1/*
2 * Copyright 2009-2020 The VOTCA Development Team (http://www.votca.org)
3 *
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
7 *
8 * http://www.apache.org/licenses/LICENSE-2.0
9 *
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
15 *
16 */
17
18#ifndef VOTCA_CSG_BEADMOTIFALGORITHMS_H
19#define VOTCA_CSG_BEADMOTIFALGORITHMS_H
20
21// Local VOTCA includes
22#include "beadmotif.h"
23#include "beadmotifconnector.h"
24#include "beadstructure.h"
26
27namespace votca {
28namespace csg {
29
39template <class T>
40T breakIntoMotifs(BeadStructure &beadstructure) {
41 T bead_motifs;
42 std::vector<BeadStructure> structures = breakIntoStructures(beadstructure);
43 for (BeadStructure &structure : structures) {
44 bead_motifs.push_back(BeadMotif(structure));
45 }
46 return bead_motifs;
47}
48
80std::pair<std::unordered_map<Index, BeadMotif>, BeadMotifConnector>
81 breakIntoSimpleMotifs(BeadMotif bead_motif);
82
83} // namespace csg
84} // namespace votca
85
86#endif // VOTCA_CSG_BEADMOTIFALGORITHMS_H
Designed determine what kind of structure a beadstructure has.
Definition beadmotif.h:111
Designed to determine if the structure beads passed in.
T breakIntoMotifs(BeadStructure &beadstructure)
breaks a beadstructure into individual motifs.
std::vector< BeadStructure > breakIntoStructures(BeadStructure &beadstructure)
std::pair< std::unordered_map< Index, BeadMotif >, BeadMotifConnector > breakIntoSimpleMotifs(BeadMotif bead_motif)
This function will take a beadmotif and break it into its simple motifs.
base class for all analysis tools
Definition basebead.h:33