faunus
Public Member Functions | List of all members
Faunus::analysis::PatchySpheroCylinderTrajectory Class Reference

Generate PSCs text trajectory containing. More...

#include <analysis.h>

Inheritance diagram for Faunus::analysis::PatchySpheroCylinderTrajectory:
Inheritance graph
[legend]
Collaboration diagram for Faunus::analysis::PatchySpheroCylinderTrajectory:
Collaboration graph
[legend]

Public Member Functions

 PatchySpheroCylinderTrajectory (const json &j, const Space &spc)
 
- Public Member Functions inherited from Faunus::analysis::QRtraj
 QRtraj (const json &j, const Space &spc, const std::string &name="qrtraj")
 
- Public Member Functions inherited from Faunus::analysis::Analysis
void to_json (json &j) const
 JSON report w. statistics, output etc.
 
void from_json (const json &j)
 configure from json object
 
void to_disk ()
 Save data to disk (if defined) More...
 
void sample ()
 Increase step count and sample. More...
 
int getNumberOfSteps () const
 Number of steps.
 
 Analysis (const Space &spc, std::string_view name)
 
 Analysis (const Space &spc, std::string_view name, int sample_interval, int number_of_skipped_steps)
 

Additional Inherited Members

- Public Attributes inherited from Faunus::analysis::Analysis
const std::string name
 descriptive name
 
std::string cite
 url, doi etc. describing the analysis
 
- Protected Attributes inherited from Faunus::analysis::QRtraj
std::function< void()> write_to_file
 Write a single frame to stream.
 
std::unique_ptr< std::ostream > stream = nullptr
 Output stream.
 
- Protected Attributes inherited from Faunus::analysis::Analysis
const Spacespc
 Instance of Space to analyse.
 
int sample_interval = 0
 Steps in between each sample point (do not modify)
 
int number_of_samples = 0
 counter for number of samples
 

Detailed Description

Generate PSCs text trajectory containing.

  1. number of particles (incl. inactive)
  2. step number and box dimensions
  3. midpoint position; direction; patch direction

This can be used to generate VMD visualisation using a conversion script (see scripts/ folder)


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