#include <IMP/npctransport/SlabWithToroidalPore.h>
A decorator for a particle that represents a slab containing a toroidal pore
Definition at line 24 of file SlabWithToroidalPore.h.
|
static bool | get_is_setup (const IMP::ParticleAdaptor &p) |
|
static bool | get_is_setup (Model *m, ParticleIndex pi) |
| Return true if the particle is an instance of SlabWithToroidalPore. More...
|
|
static FloatKey | get_minor_radius_h2v_aspect_ratio_key () |
| Get the decorator key for the ratio between horizontal and vertical aspect ratio. More...
|
|
static IntKey | get_toroidal_pore_key () |
| Get the decorator key indicating a toroidal pore. More...
|
|
static SlabWithToroidalPore | setup_particle (Model *m, ParticleIndex pi, double thickness, double major_radius) |
|
static SlabWithToroidalPore | setup_particle (IMP::ParticleAdaptor decorator, double thickness, double major_radius) |
|
static SlabWithToroidalPore | setup_particle (Model *m, ParticleIndex pi, double thickness, double major_radius, double minor_radius_h2v_aspect_ratio) |
|
static SlabWithToroidalPore | setup_particle (IMP::ParticleAdaptor decorator, double thickness, double major_radius, double minor_radius_h2v_aspect_ratio) |
|
static bool | get_is_setup (const IMP::ParticleAdaptor &p) |
|
static bool | get_is_setup (Model *m, ParticleIndex pi) |
| Return true if the particle is an instance of SlabWithPore. More...
|
|
static FloatKey | get_pore_radius_key () |
| Get the key for the pore radius. More...
|
|
static FloatKey | get_thickness_key () |
| Get the decorator key for is_last_entry_from_top. More...
|
|
static SlabWithPore | setup_particle (IMP::ParticleAdaptor decorator, double thickness, double pore_radius) |
|
static SlabWithPore | setup_particle (Model *m, ParticleIndex pi, double thickness, double pore_radius) |
|
static bool IMP::npctransport::SlabWithToroidalPore::get_is_setup |
( |
Model * |
m, |
|
|
ParticleIndex |
pi |
|
) |
| |
|
static |
static FloatKey IMP::npctransport::SlabWithToroidalPore::get_minor_radius_h2v_aspect_ratio_key |
( |
| ) |
|
|
static |
Get the decorator key for the ratio between horizontal and vertical aspect ratio.
static IntKey IMP::npctransport::SlabWithToroidalPore::get_toroidal_pore_key |
( |
| ) |
|
|
static |
Get the decorator key indicating a toroidal pore.
Decorate a particle that represents a slab (e.g. nuclear envelope) with specified thickness and a toroidal pore of specified major radius and minor radius of 0.5*thickness, with equal horizontal and vertical minor radii.
The slab is parallel to the x,y plain from z=-0.5*thickness to z=0.5*thickness, and the central axis of the pore lies on the origin.
- Parameters
-
m | the model |
pi | the particle index |
thickness | slab thickness, also twice the minor radius |
major_radius | pore major radiusSetup the particle so it can be used with this decorator. |
Definition at line 70 of file SlabWithToroidalPore.h.
static SlabWithToroidalPore IMP::npctransport::SlabWithToroidalPore::setup_particle |
( |
Model * |
m, |
|
|
ParticleIndex |
pi, |
|
|
double |
thickness, |
|
|
double |
major_radius, |
|
|
double |
minor_radius_h2v_aspect_ratio |
|
) |
| |
|
static |
Decorate a particle that represents a slab (e.g. nuclear envelope) with specified thickness and a toroidal pore of specified major radius and minor radius of 0.5*thickness, and specified ratio between horizontal and vertical minor radii.
The slab is parallel to the x,y plain from z=-0.5*thickness to z=0.5*thickness, and the central axis of the pore lies on the origin.
- Parameters
-
m | the model |
pi | the particle index |
thickness | slab thickness, also twice the vertical minor radius |
major_radius | pore major radius |
minor_radius_h2v_aspect_ratio | ratio between horizontal and vertical minor radiusSetup the particle so it can be used with this decorator. |
Definition at line 93 of file SlabWithToroidalPore.h.
The documentation for this class was generated from the following file: