Detailed Description

A decorator for a particle that represents a slab containing a cylindrical pore

Definition at line 24 of file SlabWithCylindricalPore.h.

Public Member Functions
	SlabWithCylindricalPore (::IMP::Model *m,::IMP::ParticleIndex id)

	SlabWithCylindricalPore (const IMP::ParticleAdaptor &d)

void	show (std::ostream &out=std::cout) const

Public Member Functions inherited from IMP::npctransport::SlabWithPore
	SlabWithPore (::IMP::Model *m,::IMP::ParticleIndex id)

	SlabWithPore (const IMP::ParticleAdaptor &d)

void	add_to_pore_radius_derivative (double v, DerivativeAccumulator &d)

Float	get_pore_radius () const
	get cylindrical pore radius More...

bool	get_pore_radius_is_optimized () const

Float	get_thickness () const
	returns whether the particle last entered the transport moiety from its More...

void	set_pore_radius (double r) const
	set cylindrical pore radius More...

void	set_pore_radius_is_optimized (bool tf) const
	Set whether the coordinates are optimized. More...

void	set_thickness (double thickness)
	sets slab thickness More...

void	show (std::ostream &out=std::cout) const

Public Member Functions inherited from IMP::Decorator
bool	get_is_valid () const
	Returns true if constructed with a non-default constructor. More...

Model *	get_model () const
	Returns the Model containing the particle. More...

Particle *	get_particle () const
	Returns the particle decorated by this decorator. More...

ParticleIndex	get_particle_index () const
	Returns the particle index decorated by this decorator. More...

	operator Particle * () const

	operator ParticleIndex () const

Particle *	operator-> () const

Static Public Member Functions
static IntKey	get_cylindrical_pore_key ()
	Get the decorator key indicating a cylindrical pore. More...

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 SlabWithCylindricalPore. More...

static SlabWithCylindricalPore	setup_particle (IMP::ParticleAdaptor decorator, double thickness, double radius)

static SlabWithCylindricalPore	setup_particle (Model *m, ParticleIndex pi, double thickness, double radius)

Static Public Member Functions inherited from IMP::npctransport::SlabWithPore
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)

Additional Inherited Members
Protected Member Functions inherited from IMP::Decorator
	Decorator (Model *m, ParticleIndex pi)

	Decorator (ParticleAdaptor p)

Member Function Documentation

static IntKey IMP::npctransport::SlabWithCylindricalPore::get_cylindrical_pore_key ( )

static

Get the decorator key indicating a cylindrical pore.

static bool IMP::npctransport::SlabWithCylindricalPore::get_is_setup	(	Model *	m,
		ParticleIndex	pi
	)

static

Return true if the particle is an instance of SlabWithCylindricalPore.

Definition at line 70 of file SlabWithCylindricalPore.h.

Here is the call graph for this function:

static SlabWithCylindricalPore IMP::npctransport::SlabWithCylindricalPore::setup_particle	(	Model *	m,
		ParticleIndex	pi,
		double	thickness,
		double	radius
	)

static

Decorate a particle that represents a slab (e.g. nuclear envelope) with specified thickness and a cylindrical pore of specified radius.

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
radius	pore radiusSetup the particle so it can be used with this decorator.

Definition at line 67 of file SlabWithCylindricalPore.h.

The documentation for this class was generated from the following file: