faunus
Public Types | Public Attributes | Friends | List of all members
Faunus::SpheroCylinderData Class Reference

Static properties for patchy sphero cylinders (PSC) More...

#include <atomdata.h>

Public Types

enum  PatchType { PatchType::None = 0, PatchType::Full = 1, PatchType::Capped = 2, PatchType::Invalid = 3 }
 

Public Attributes

double chiral_angle = 0.0
 Rotation of patch relative to direction (radians)
 
double length = 0.0
 Sphere-cylinder length.
 
double patch_angle = 0.0
 Opening angle of attrative patch (radians)
 
double patch_angle_switch
 Gradually switch on patch interaction over angular interval (radians) More...
 
PatchType type = PatchType::None
 Patch type of spherocylinder.
 

Friends

void from_json (const json &, SpheroCylinderData &)
 
void to_json (json &, const SpheroCylinderData &)
 

Detailed Description

Static properties for patchy sphero cylinders (PSC)

Member Enumeration Documentation

◆ PatchType

Enumerator
None 

No patch.

Full 

Patch runs the full length of the SC.

Capped 

Patch stops before the end caps.

Invalid 

Used to detect invalid input.

Member Data Documentation

◆ patch_angle_switch

double Faunus::SpheroCylinderData::patch_angle_switch
Initial value:
=
0.0

Gradually switch on patch interaction over angular interval (radians)


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