qrunch.chemistry.reaction_path_problem.builders.simple_reaction_path_problem_builders
Module containing a simple reaction path problem builder.
Classes
Simple reaction path problem builder. |
- class SimpleReactionPathProblemBuilder
Bases:
ReactionPathProblemBuilderSimple reaction path problem builder.
Each molecular ground state problem is made one at a time without knowledge of the rest of the reaction.
When the underlying ground state problem builder is configured with a
DataPersisterManager, the resultingUnrestrictedReactionPathProblem/RestrictedReactionPathProblemwill hold lazy on-disk references (one per geometry) instead of the full in-memory problems. This keeps peak memory usage bounded to a single ground state problem, which is important when each problem can be many GB.- __init__(ground_state_problem_builder: GroundStateProblemBuilder) None
Initialize an instance of the simple reaction path problem builder.
- Parameters:
ground_state_problem_builder (GroundStateProblemBuilder) – Problem builder to be used on every molecular configuration in the reaction.
- Return type:
None
- build_restricted(reaction_configuration: ReactionConfiguration) RestrictedReactionPathProblem
Build the restricted reaction path problem.
When the underlying ground state problem builder has a
DataPersisterManagerconfigured, each per-geometry ground state problem is built, persisted via the manager and immediately released; the returned reaction path problem then holds lazy on-disk references. Otherwise, every problem is built and kept fully in memory.- Parameters:
reaction_configuration (ReactionConfiguration) – The reaction configuration object.
- Return type:
- build_restricted_cube_files(reaction_configuration: ReactionConfiguration) None
Build restricted cube files.
- Parameters:
reaction_configuration (ReactionConfiguration) – The reaction configuration object.
- Return type:
None
- build_unrestricted(reaction_configuration: ReactionConfiguration) UnrestrictedReactionPathProblem
Build the unrestricted reaction path problem.
When the underlying ground state problem builder has a
DataPersisterManagerconfigured, each per-geometry ground state problem is built, persisted via the manager and immediately released; the returned reaction path problem then holds lazy on-disk references. Otherwise, every problem is built and kept fully in memory.- Parameters:
reaction_configuration (ReactionConfiguration) – The reaction configuration object.
- Return type:
- build_unrestricted_cube_files(reaction_configuration: ReactionConfiguration) None
Build unrestricted cube files.
- Parameters:
reaction_configuration (ReactionConfiguration) – The reaction configuration object.
- Return type:
None