PSCF v1.4.0
Pscf::Rpc::BinaryStructureFactor< D > Class Template Reference

Spherically averaged structure factor for a two-monomer system. More...

#include <BinaryStructureFactor.h>

Inheritance diagram for Pscf::Rpc::BinaryStructureFactor< D >:
Pscf::Rp::BinaryStructureFactor< D, Types< D > >

Public Member Functions

 BinaryStructureFactor (Simulator< D > &simulator, System< D > &system)
 Constructor.
void setup () override
 Setup before the main loop.
void sample (long iStep) override
 Compute structure factors and add to accumulators.
Public Member Functions inherited from Pscf::Rp::BinaryStructureFactor< D, Types< D > >
 BinaryStructureFactor (typename Types< D >::Simulator &simulator, typename Types< D >::System &system)
 Constructor.
void readParameters (std::istream &in) override
 Read parameters from file.
void output () override
 Output results to predefined output file.

Additional Inherited Members

Protected Member Functions inherited from Pscf::Rp::BinaryStructureFactor< D, Types< D > >
void allocate ()
 Allocate member arrays with dimensions that depend only on mesh.
void findWaveBunches (Array< double > const &kSq, Array< bool > const &implicit)
 Allocate and initialize data structures involving wave bunches.
void computeW ()
 Compute member variables wm_ and wk_.
void computeS (Array< typename Types< D >::Complex > const &wk)
 Complete calculation of current structure factors.
Protected Attributes inherited from Pscf::Rp::BinaryStructureFactor< D, Types< D > >
Types< D >::RFieldDft wk_
 Discrete Fourier transform (DFT) of wm_ .

Detailed Description

template<int D>
class Pscf::Rpc::BinaryStructureFactor< D >

Spherically averaged structure factor for a two-monomer system.

Specializations of this template are derived from specializations of the base class template Rp::BinaryStructureFactor, and inherit most of their source code from this base class.

See also
Rp::BinaryStructureFactor
Manual Page

Definition at line 37 of file /fts/analyzer/BinaryStructureFactor.h.

Constructor & Destructor Documentation

◆ BinaryStructureFactor()

template<int D>
Pscf::Rpc::BinaryStructureFactor< D >::BinaryStructureFactor ( Simulator< D > & simulator,
System< D > & system )

Constructor.

Parameters
simulatorparent Simulator object
systemparent System object

Definition at line 35 of file BinaryStructureFactor.cpp.

References BinaryStructureFactor().

Referenced by BinaryStructureFactor().

Member Function Documentation

◆ setup()

◆ sample()

template<int D>
void Pscf::Rpc::BinaryStructureFactor< D >::sample ( long iStep)
override

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