IMP logo
IMP Reference Guide  2.20.0
The Integrative Modeling Platform
main.h
Go to the documentation of this file.
1 /**
2  * \file main.h
3  * \brief Helper functions for executable .cpp files
4  *
5  * Copyright 2007-2022 IMP Inventors. All rights reserved.
6  */
7 
8 #ifndef IMPNPCTRANSPORT_MAIN_H
9 #define IMPNPCTRANSPORT_MAIN_H
10 
11 #include "npctransport_config.h"
12 #include "SimulationData.h"
13 #include <IMP/base_types.h>
14 #include <string>
15 
16 IMPNPCTRANSPORT_BEGIN_NAMESPACE
17 
18 /**
19  initialize and return a simulation data object based on
20  program command line parameters
21 
22  @throw IMP::IOException if there was any IO problem
23 */
24 IMPNPCTRANSPORTEXPORT
25 IMP::npctransport::SimulationData *startup(int argc, char *argv[]);
26 
27 //! remove nup42 and its anchors (also from obstacles)
28 IMPNPCTRANSPORTEXPORT
29 void remove_Nup42(SimulationData* sd);
30 
31 //! inflate floater of specified type to new_radius
32 IMPNPCTRANSPORTEXPORT
33 void inflate_floater
34 (SimulationData* sd, const std::string floater_name, const float new_radius);
35 
36 //! change box size sd to specified box size and update output file
37 IMPNPCTRANSPORTEXPORT
38 void reset_box_size(SimulationData* sd, double box_size);
39 
40 /** Run simulation using preconstructed SimulationData object sd.
41 
42  @param sd SimulationData object to optimize
43  @param init_restraints ad-hoc restraints during initialization only
44 */
45 IMPNPCTRANSPORTEXPORT
46 void do_main_loop(SimulationData *sd, const RestraintsTemp &init_restraints);
47 
48 IMPNPCTRANSPORT_END_NAMESPACE
49 
50 #endif /* IMPNPCTRANSPORT_MAIN_H */
Basic types used by IMP.
void remove_Nup42(SimulationData *sd)
remove nup42 and its anchors (also from obstacles)
IMP::npctransport::SimulationData * startup(int argc, char *argv[])
void do_main_loop(SimulationData *sd, const RestraintsTemp &init_restraints)
IMP::Vector< IMP::WeakPointer< Restraint > > RestraintsTemp
Definition: base_types.h:104
void inflate_floater(SimulationData *sd, const std::string floater_name, const float new_radius)
inflate floater of specified type to new_radius
Store all parameters for a simulation.
description
void reset_box_size(SimulationData *sd, double box_size)
change box size sd to specified box size and update output file