PSCF v1.4.0
Pscf::Rp Namespace Reference

Class templates for real-valued periodic fields. More...

Classes

class  AmCompressor
 Anderson mixing compressor. More...
class  AmIteratorBasis
 Anderson Mixing iterator with imposed space-group symmetry. More...
class  AmIteratorGrid
 Anderson mixing iterator on grid (no space-group symmetry). More...
class  Analyzer
 Abstract base for periodic output and/or analysis actions. More...
class  AnalyzerManager
 Manager for a list of Analyzer objects. More...
class  AverageAnalyzer
 Analyze averages and block averages of a single real variable. More...
class  AverageListAnalyzer
 Analyze averages and block averages of several real variables. More...
class  BasisFieldState
 FieldState for fields in symmetry-adapted basis format. More...
class  BdMove
 Brownian dynamics Monte-Carlo move. More...
class  BdSimulator
 Brownian dynamics simulator for PS-FTS. More...
class  BdStep
 Template for abstract base class for Brownian dynamics (BD) steps. More...
class  BinaryChiDerivative
 Evaluate derivative of H with respect to chi for binary system. More...
class  BinaryStructureFactor
 Spherically averaged structure factor for a two-monomer system. More...
class  CFields
 A list of c fields stored in both basis and r-grid format. More...
class  ConcentrationDerivative
 Evaluate the derivative of H with respect to concentration. More...
class  ConcentrationWriter
 Periodically write c-field snapshots to a trajectory file. More...
class  CubicLengthDerivative
 Evaluate the derivative of H with respect to cubic box length L. More...
class  Domain
 Spatial domain for a periodic structure with real fields. More...
class  EinsteinCrystalPerturbation
 Perturbation for Einstein crystal thermodynamic integration. More...
class  ExplicitBdStep
 Explicit Euler-Maruyama Brownian dynamics step. More...
class  FieldIo
 File input/output, format conversions and other utilities for fields. More...
class  ForceBiasMove
 ForceBiasMove attempts a Brownian dynamics move. More...
class  FourthOrderParameter
 FourthOrderParameter is used to detect an order-disorder transition. More...
class  HamiltonianAnalyzer
 Compute averages and output block averages of Hamiltonian components. More...
class  IntraCorrelation
 Intramolecular correlation analyzer. More...
class  Iterator
 Base class template for iterative solvers for SCF equations. More...
class  LinearRamp
 Linear ramp - parameters vary linearly with step index. More...
class  LinearSweep
 Sweep in which parameters vary linearly with sweep variable s. More...
class  LMBdStep
 Leimkuhler-Matthews Brownian dynamics stepper. More...
class  LrAmCompressor
 Anderson mixing compressor with linear-response correction step. More...
class  LrCompressor
 Linear response compressor. More...
class  Mask
 A field that specifies an inhomogeneous total monomer concentration. More...
class  MaxOrderParameter
 Evaluate max of square magnitude of Fourier modes for exchange field. More...
class  McMove
 McMove is an abstract base class for Monte Carlo moves. More...
class  McMoveManager
 Manager for a set of McMove objects. More...
class  McSimulator
 Monte-Carlo simulation coordinator. More...
class  Mixture
 Solver and descriptor for a mixture of polymers and solvents. More...
class  MixtureModifier
 Modifier for parameters of an associated mixture. More...
class  Perturbation
 Base class for additive perturbations of standard FTS Hamiltonian. More...
class  PerturbationDerivative
 Evaluate derivative of H w/ respect to perturbation parameter lambda. More...
class  Polymer
 Descriptor and MDE solver for one polymer species. More...
class  PredCorrBdStep
 Predictor-corrector Brownian dynamics stepper. More...
class  Propagator
 MDE solver for one direction of one block. More...
class  Ramp
 Class that varies parameters during a simulation (abstract). More...
class  RampParameter
 Class for storing data about an individual linear ramp parameter. More...
class  RealMove
 RealMove generates spatially uncorrelated random field changes. More...
class  RGridTrajectoryReader
 Trajectory file reader. More...
class  ScftThermo
 Base class for SCFT thermodynamic property calculators. More...
class  ShiftMove
 ShiftMove rigidly translates the field. More...
struct  SimState
 SimState stores the state used by a FTS simulation. More...
class  Simulator
 Base class for field theoretic PS-FTS simulator. More...
class  Solvent
 Solver and descriptor for a solvent species. More...
class  StepLogger
 Periodically write the step index to a log file. More...
class  Sweep
 Solve a sequence of SCFT problems along a line in parameter space. More...
class  SweepParameter
 Class template for storing data about an individual sweep parameter. More...
class  System
 Base class template for classes that represent a complete system. More...
class  SystemConstRef
 Base class template for const access to an associated System. More...
class  TrajectoryReader
 Trajectory file reader (abstract base class). More...
class  TrajectoryWriter
 Periodically write field frames (snapshots) to a trajectory file. More...
class  WFields
 A container of w fields stored in both basis and r-grid format. More...

Functions

template<int D, class T>
std::istream & operator>> (std::istream &in, RampParameter< D, T > &param)
 Inserter for reading a RampParameter from an istream.
template<int D, class T>
std::ostream & operator<< (std::ostream &out, RampParameter< D, T > const &param)
 Extractor for writing a RampParameter to ostream.
template<int D, class T>
std::istream & operator>> (std::istream &in, SweepParameter< D, T > &param)
 Inserter for reading a SweepParameter<D,T> from an istream.
template<int D, class T>
std::ostream & operator<< (std::ostream &out, SweepParameter< D, T > const &param)
 Extractor for writing a SweepParameter<D,T> to an ostream.

Detailed Description

Class templates for real-valued periodic fields.

Function Documentation

◆ operator>>() [1/2]

template<int D, class T>
std::istream & Pscf::Rp::operator>> ( std::istream & in,
RampParameter< D, T > & param )

Inserter for reading a RampParameter from an istream.

Parameters
ininput stream
paramRampParameter<D> object to read

Definition at line 320 of file fts/ramp/RampParameter.h.

◆ operator<<() [1/2]

template<int D, class T>
std::ostream & Pscf::Rp::operator<< ( std::ostream & out,
RampParameter< D, T > const & param )

Extractor for writing a RampParameter to ostream.

Parameters
outoutput stream
paramRampParameter<D> object to write

Definition at line 343 of file fts/ramp/RampParameter.h.

References Pscf::Rp::RampParameter< D, T >::id(), and Pscf::Rp::RampParameter< D, T >::writeParamType().

◆ operator>>() [2/2]

template<int D, class T>
std::istream & Pscf::Rp::operator>> ( std::istream & in,
SweepParameter< D, T > & param )

Inserter for reading a SweepParameter<D,T> from an istream.

Parameters
ininput stream
paramSweepParameter<D,T> object to read

Definition at line 339 of file rp/scft/sweep/SweepParameter.h.

◆ operator<<() [2/2]

template<int D, class T>
std::ostream & Pscf::Rp::operator<< ( std::ostream & out,
SweepParameter< D, T > const & param )

Extractor for writing a SweepParameter<D,T> to an ostream.

Parameters
outoutput stream
paramSweepParameter<D,T> object to write

Definition at line 362 of file rp/scft/sweep/SweepParameter.h.

References Pscf::Rp::SweepParameter< D, T >::id(), and Pscf::Rp::SweepParameter< D, T >::writeParamType().