Broken Bonds
Broken Bonds from Fragmented Nuclei
This module takes as input a set of disjoint fragments and the connectivity of the supersystem. Using the connectivity of the supersystem it then determines the bonds that were broken in forming the fragments.
Please Cite
No citations
Property Types
The following is a list of property types that this module satisfies.
ghostfragment::pt::BrokenBonds
Module Inputs
This section details the full list of inputs that the module accepts. Inputs
that are not listed as optional must have their value set before the module can
be run. Inputs can be set manually by calling the module’s change_input
function or by passing arguments to a property type.
Quick Reference
The following table provides a quick summary of the inputs available to this module. The columns are:
Key
: The key used to retrieve the option,Default
: The initial value, if one exists, andDescription
: A human readable description of what the option is used for.
Key |
Default |
Description |
---|---|---|
Connections |
N/A |
N/A |
Fragments |
N/A |
N/A |
Detailed Descriptions
The following subsections provide detailed descriptions of each input recognized by this module. The subsection headings are the name of the input. Within each subsection we list:
Description
: A human readable description of what the option is used for.Default Value
: The initial value, if one exists.Optional?
: Whether the value must be set inorder for the module to run.Opaque?
: Does the value of the input influence memoization?.Domain Restrictions
: Criteria a value must obey to be deemed valid.
Connections
Description : N/A
Default Value : N/A
Optional? : False
Opaque? : True
Domain Restrictions :
Type == chemist::topology::ConnectivityTable
Fragments
Description : N/A
Default Value : N/A
Optional? : False
Opaque? : True
Domain Restrictions :
Type == chemist::fragmenting::FragmentedNuclei<chemist::Nuclei>
Module Results
This section tabulates the full list of results that the module returns. The columns respectively are:
Key: What the result is called
Type: The C++ type of the result
Description: What the result is/how it was computed.
Note
A given property type will only return a subset of the available results. Additional results can be accessed by using other property types or by using the Module class’s advanced API.
Key |
Type |
Description |
---|---|---|
Broken Bonds |
std::set<std::pair<unsigned long, unsigned long>, std::less<std::pair<unsigned long, unsigned long>>, std::allocator<std::pair<unsigned long, unsigned long>>> |
N/A |
Submodules
The module defines no submodules.