BornAgain  1.18.0
Simulate and fit neutron and x-ray scattering at grazing incidence
Public Member Functions | Protected Attributes | List of all members
Particle Class Reference
Samples

A particle with a form factor and refractive index. More...

+ Inheritance diagram for Particle:

Public Member Functions

 Particle (Material material)
 
 Particle (Material material, const IFormFactor &form_factor)
 
 Particle (Material material, const IFormFactor &form_factor, const IRotation &rotation)
 
Particle * clone () const override final
 Returns a clone of this ISample object.
 
void accept (INodeVisitor *visitor) const override final
 Calls the INodeVisitor's visit method.
 
SlicedParticle createSlicedParticle (ZLimits limits) const override final
 Creates a sliced form factor for this particle.
 
void setMaterial (Material material)
 
const Material * material () const override final
 Returns nullptr, unless overwritten to return a specific material.
 
void setFormFactor (const IFormFactor &form_factor)
 
std::vector< const INode * > getChildren () const override final
 Returns a vector of children (const).
 
- Public Member Functions inherited from IParticle
virtual IFormFactor * createFormFactor () const
 Creates a form factor for this particle.
 
kvector_t position () const
 Returns particle position.
 
void setPosition (kvector_t position)
 Sets relative position of the particle's reference point in the coordinate system of parent. More...
 
void setPosition (double x, double y, double z)
 Sets relative position of the particle's reference point in the coordinate system of parent. More...
 
void translate (kvector_t translation) override final
 Translates the particle.
 
const IRotation * rotation () const
 Returns rotation object.
 
void setRotation (const IRotation &rotation)
 Sets transformation.
 
void rotate (const IRotation &rotation) override final
 Rotates the particle.
 
void registerAbundance (bool make_registered=true)
 
void registerPosition (bool make_registered=true)
 Registers the three components of its position.
 
virtual SafePointerVector< IParticle > decompose () const
 Decompose in constituent IParticle objects.
 
virtual ParticleLimits bottomTopZ () const
 Top and bottom z-coordinate.
 
- Public Member Functions inherited from IAbstractParticle
 IAbstractParticle (const NodeMeta &meta, const std::vector< double > &PValues)
 
double abundance () const
 
void setAbundance (double abundance)
 Sets particle abundance. More...
 
- Public Member Functions inherited from ISample
 ISample (const NodeMeta &meta, const std::vector< double > &PValues)
 
std::vector< const Material * > containedMaterials () const
 Returns set of unique materials contained in this ISample.
 
- Public Member Functions inherited from ICloneable
 ICloneable (const ICloneable &)=delete
 
 ICloneable (ICloneable &&)=default
 
virtual void transferToCPP ()
 Used for Python overriding of clone (see swig/tweaks.py)
 
- Public Member Functions inherited from INode
 INode (const NodeMeta &meta, const std::vector< double > &PValues)
 
virtual std::string treeToString () const
 Returns multiline string representing tree structure below the node.
 
void registerChild (INode *node)
 
virtual void setParent (const INode *newParent)
 
const INode * parent () const
 
INode * parent ()
 
int copyNumber (const INode *node) const
 Returns copyNumber of child, which takes into account existence of children with same name.
 
std::string displayName () const
 Returns display name, composed from the name of node and it's copy number.
 
ParameterPool * createParameterTree () const
 Creates new parameter pool, with all local parameters and those of its children.
 
- Public Member Functions inherited from IParameterized
 IParameterized (const std::string &name="")
 
 IParameterized (const IParameterized &other)
 
IParameterized & operator= (const IParameterized &other)=delete
 
ParameterPool * parameterPool () const
 Returns pointer to the parameter pool.
 
std::string parametersToString () const
 Returns multiline string representing available parameters.
 
RealParameter & registerParameter (const std::string &name, double *parpointer)
 
void registerVector (const std::string &base_name, kvector_t *p_vec, const std::string &units="nm")
 
void setParameterValue (const std::string &name, double value)
 
void setVectorValue (const std::string &base_name, kvector_t value)
 
RealParameter * parameter (const std::string &name) const
 Returns parameter with given 'name'.
 
virtual void onChange ()
 Action to be taken in inherited class when a parameter has changed.
 
void removeParameter (const std::string &name)
 
void removeVector (const std::string &base_name)
 
void setName (const std::string &name)
 
const std::string & getName () const
 

Protected Attributes

Material m_material
 
std::unique_ptr< IFormFactor > mP_form_factor
 
- Protected Attributes inherited from IParticle
kvector_t m_position
 
std::unique_ptr< IRotation > mP_rotation
 
- Protected Attributes inherited from IAbstractParticle
double m_abundance {1.0}
 
- Protected Attributes inherited from INode
const size_t m_NP
 
std::vector< double > m_P
 

Additional Inherited Members

- Static Public Member Functions inherited from IParameterized
static std::string XComponentName (const std::string &base_name)
 
static std::string YComponentName (const std::string &base_name)
 
static std::string ZComponentName (const std::string &base_name)
 
- Protected Member Functions inherited from IParticle
IRotation * createComposedRotation (const IRotation *p_rotation) const
 Creates a composed IRotation object.
 
kvector_t composedTranslation (const IRotation *p_rotation, kvector_t translation) const
 Gets a composed translation vector.
 
void registerParticleProperties ()
 Registers abundance and position.
 

Detailed Description

A particle with a form factor and refractive index.

Definition at line 25 of file Particle.h.

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