SlabWithToroidalPoreGoPairScore.h

Go to the documentation of this file.

/**
 *  \file IMP/npc/SlabWithToroidalPoreGoPairScore.h
 *  \brief a go-like score for a slab with a toroidal pore
 *

 *  Copyright 2007-2018 IMP Inventors. All rights reserved.
 *
 */

#ifndef IMPNPC_SLAB_WITH_TOROIDAL_PORE_GO_PAIR_SCORE_H
#define IMPNPC_SLAB_WITH_TOROIDAL_PORE_GO_PAIR_SCORE_H

#include "npc_config.h"
#include "SlabWithToroidalPore.h"
#include <IMP/Model.h>
#include <IMP/Pointer.h>
#include <IMP/check_macros.h>
#include <IMP/PairScore.h>
#include <IMP/pair_macros.h>
#include "IMP/core/XYZR.h"

IMPNPC_BEGIN_NAMESPACE

//! apply a harmonic to the distance between a particle and the normal to toroidal membrane
/** The source code is as follows:
 * \include SlabWithToroidalPoreGoPairScore.h
 * \include SlabWithToroidalPoreGoPairScore.cpp
 */

// scores a go-like harmonic interaction based on normal distance to closest point
class IMPNPCEXPORT SlabWithToroidalPoreGoPairScore : public PairScore {
    double x0_, k_;

public:
/**
 * Constructs a score over a horizontal slab with a toroidal indent.

   @param k the slab repulsive force constant in kcal/mol/A
 */
SlabWithToroidalPoreGoPairScore(double x0, double k);
virtual double evaluate_index(Model *m,
                              const ParticleIndexPair &p,
                              DerivativeAccumulator *da) const override;

virtual ModelObjectsTemp do_get_inputs(Model *m,
                                       const ParticleIndexes &pis) const override;

IMP_PAIR_SCORE_METHODS(SlabWithToroidalPoreGoPairScore);
IMP_OBJECT_METHODS(SlabWithToroidalPoreGoPairScore);

};

IMP_OBJECTS(SlabWithToroidalPoreGoPairScore, SlabWithToroidalPoreGoPairScores);

IMPNPC_END_NAMESPACE

#endif /* IMPNPC_SLAB_WITH_TOROIDAL_PORE_GO_PAIR_SCORE_H */