PSCF v1.3
rpc/field/FieldIo.h
1#ifndef RPC_FIELD_IO_H
2#define RPC_FIELD_IO_H
3
4/*
5* PSCF - Polymer Self-Consistent Field
6*
7* Copyright 2015 - 2025, The Regents of the University of Minnesota
8* Distributed under the terms of the GNU General Public License.
9*/
10
11#include <prdc/field/FieldIoReal.h> // base class template
12#include <prdc/cpu/RField.h> // template parameter
13#include <prdc/cpu/RFieldDft.h> // template parameter
14#include <prdc/cpu/FFT.h> // template parameter
15
16// Forward declarations
17namespace Util {
18 class FileMaster;
19 template <typename T> class DArray;
20}
21namespace Pscf {
22 namespace Prdc {
23 template <int D> class UnitCell;
24 }
25}
26
27namespace Pscf {
28namespace Rpc {
29
30 using namespace Util;
31 using namespace Pscf::Prdc;
32 using namespace Pscf::Prdc::Cpu;
33
56 template <int D>
57 class FieldIo
58 : public FieldIoReal< D, RField<D>, RFieldDft<D>, FFT<D> >
59 {
60
61 public:
62
73 bool readFieldsRGrid(std::istream& in,
74 DArray< RField<D> >& fields,
75 UnitCell<D> & unitCell) const override;
76
86 void readFieldsRGridData(std::istream& in,
87 DArray< RField<D> >& fields,
88 int nMonomer) const override;
89
100 bool readFieldRGrid(std::istream &in,
101 RField<D> & field,
102 UnitCell<D>& unitCell) const override;
103
116 void writeFieldsRGrid(std::ostream& out,
117 DArray< RField<D> > const & fields,
118 UnitCell<D> const & unitCell,
119 bool writeHeader = true,
120 bool isSymmetric = true,
121 bool writeMeshSize = true) const override;
122
134 void writeFieldRGrid(std::ostream &out,
135 RField<D> const & field,
136 UnitCell<D> const & unitCell,
137 bool writeHeader = true,
138 bool isSymmetric = true)
139 const override;
140
150 void readFieldsKGrid(std::istream& in,
151 DArray< RFieldDft<D> >& fields,
152 UnitCell<D> & unitCell)
153 const override;
154
165 void writeFieldsKGrid(std::ostream& out,
166 DArray< RFieldDft<D> > const & fields,
167 UnitCell<D> const & unitCell,
168 bool isSymmetric = true)
169 const override;
170
179 void convertBasisToKGrid(DArray<double> const & components,
180 RFieldDft<D>& dft)
181 const override;
182
193 void convertKGridToBasis(RFieldDft<D> const & in,
194 DArray<double> & out,
195 bool checkSymmetry = true,
196 double epsilon = 1.0e-8)
197 const override;
198
209 bool hasSymmetry(RFieldDft<D> const & in,
210 double epsilon = 1.0e-8,
211 bool verbose = true)
212 const override;
213
223 void compareFieldsRGrid(DArray< RField<D> > const & field1,
224 DArray< RField<D> > const & field2)
225 const override;
226
236 void scaleFieldRGrid(RField<D>& field, double factor)
237 const override;
238
251 std::ostream &out,
252 DArray<RField<D> > const & fields,
253 UnitCell<D> const & unitCell,
254 int d,
255 DArray<int> const& newGridDimensions)
256 const override;
257
269 std::ostream& out,
270 DArray< RField<D> > const & fields,
271 UnitCell<D> const & unitCell,
272 IntVec<D> const & replicas)
273 const override;
274
277
278 // Inherited public member functions
279 using Base::associate;
298 using Base::hasSymmetry;
308 using Base::mesh;
309 using Base::basis;
310 using Base::fileMaster;
311
312 protected:
313
314 // Inherited protected member functions
315 using Base::lattice;
316 using Base::hasGroup;
317 using Base::groupName;
318 using Base::group;
319 using Base::fft;
320
321 };
322
323 #ifndef RPC_FIELD_IO_TPP
324 extern template class FieldIo<1>;
325 extern template class FieldIo<2>;
326 extern template class FieldIo<3>;
327 #endif
328
329} // namespace Rpc
330
331#ifndef RPC_FIELD_IO_TPP
332namespace Prdc {
333 using namespace Cpu;
334 extern template class FieldIoReal<1, RField<1>, RFieldDft<1>, FFT<1>>;
335 extern template class FieldIoReal<2, RField<2>, RFieldDft<2>, FFT<2>>;
336 extern template class FieldIoReal<3, RField<3>, RFieldDft<3>, FFT<3>>;
337}
338#endif
339
340} // namespace Pscf
341#endif
An IntVec<D, T> is a D-component vector of elements of integer type T.
Definition IntVec.h:27
Fourier transform wrapper.
Definition cpu/FFT.h:38
Fourier transform of a real field on an FFT mesh.
Field of real double precision values on an FFT mesh.
Definition cpu/RField.h:29
File input/output, format conversions and other utilities for fields.
Definition FieldIoReal.h:86
virtual void replicateUnitCell(std::ostream &out, DArray< RField< D > > const &fields, UnitCell< D > const &unitCell, IntVec< D > const &replicas) const=0
UnitCell< D >::LatticeSystem const & lattice() const
virtual void writeFieldRGrid(std::ostream &out, RField< D > const &field, UnitCell< D > const &unitCell, bool writeHeader=true, bool isSymmetric=true) const=0
void convertRGridToBasis(RField< D > const &in, DArray< double > &out, bool checkSymmetry=true, double epsilon=1.0e-8) const
virtual void writeFieldsKGrid(std::ostream &out, DArray< RFieldDft< D > > const &fields, UnitCell< D > const &unitCell, bool isSymmetric=true) const=0
void scaleFieldsBasis(DArray< DArray< double > > &fields, double factor) const
virtual bool hasSymmetry(RFieldDft< D > const &in, double epsilon=1.0e-8, bool verbose=true) const=0
void estimateWBasis(DMatrix< double > const &chi, DArray< DArray< double > > &fields) const
virtual void convertBasisToKGrid(DArray< double > const &components, RFieldDft< D > &dft) const=0
void scaleFieldsRGrid(DArray< RField< D > > &fields, double factor) const
void writeFieldHeader(std::ostream &out, int nMonomer, UnitCell< D > const &unitCell, bool isSymmetric=true) const
void readFieldHeader(std::istream &in, int &nMonomer, UnitCell< D > &unitCell, bool &isSymmetric) const
void convertKGridToRGrid(DArray< RFieldDft< D > > const &in, DArray< RField< D > > &out) const
void associate(Mesh< D > const &mesh, FFT const &fft, typename UnitCell< D >::LatticeSystem const &lattice, bool const &hasGroup, std::string const &groupName, SpaceGroup< D > const &group, Basis< D > &basis)
virtual void convertKGridToBasis(RFieldDft< D > const &in, DArray< double > &out, bool checkSymmetry=true, double epsilon=1.0e-8) const=0
void writeFieldsBasis(std::ostream &out, DArray< DArray< double > > const &fields, UnitCell< D > const &unitCell) const
void convertBasisToRGrid(DArray< double > const &in, RField< D > &out) const
virtual void readFieldsKGrid(std::istream &in, DArray< RFieldDft< D > > &fields, UnitCell< D > &unitCell) const=0
virtual bool readFieldsRGrid(std::istream &in, DArray< RField< D > > &fields, UnitCell< D > &unitCell) const=0
virtual void compareFieldsRGrid(DArray< RField< D > > const &field1, DArray< RField< D > > const &field2) const=0
void compareFieldsBasis(DArray< DArray< double > > const &field1, DArray< DArray< double > > const &field2) const
void readFieldsBasis(std::istream &in, DArray< DArray< double > > &fields, UnitCell< D > &unitCell) const
void convertRGridToKGrid(DArray< RField< D > > const &in, DArray< RFieldDft< D > > &out) const
virtual void readFieldsRGridData(std::istream &in, DArray< RField< D > > &fields, int nMonomer) const=0
void writeFieldBasis(std::ostream &out, DArray< double > const &field, UnitCell< D > const &unitCell) const
void readFieldBasis(std::istream &in, DArray< double > &field, UnitCell< D > &unitCell) const
virtual void writeFieldsRGrid(std::ostream &out, DArray< RField< D > > const &fields, UnitCell< D > const &unitCell, bool writeHeader=true, bool isSymmetric=true, bool writeMeshSize=true) const=0
virtual void expandRGridDimension(std::ostream &out, DArray< RField< D > > const &fields, UnitCell< D > const &unitCell, int d, DArray< int > const &newGridDimensions) const=0
virtual bool readFieldRGrid(std::istream &in, RField< D > &field, UnitCell< D > &unitCell) const=0
Base template for UnitCell<D> classes, D=1, 2 or 3.
Definition UnitCell.h:56
File input/output operations and format conversions for fields.
void expandRGridDimension(std::ostream &out, DArray< RField< D > > const &fields, UnitCell< D > const &unitCell, int d, DArray< int > const &newGridDimensions) const override
Expand spatial dimension of an array of r-grid fields.
void replicateUnitCell(std::ostream &out, DArray< RField< D > > const &fields, UnitCell< D > const &unitCell, IntVec< D > const &replicas) const override
Write r-grid fields in a replicated unit cell to std::ostream.
bool hasSymmetry(RFieldDft< D > const &in, double epsilon=1.0e-8, bool verbose=true) const override
Check if a k-grid field has the declared space group symmetry.
void compareFieldsRGrid(DArray< RField< D > > const &field1, DArray< RField< D > > const &field2) const override
Compare two fields in r-grid format, output a report.
void scaleFieldRGrid(RField< D > &field, double factor) const override
Rescale a single r-grid field by a scalar factor.
void writeFieldsKGrid(std::ostream &out, DArray< RFieldDft< D > > const &fields, UnitCell< D > const &unitCell, bool isSymmetric=true) const override
Write array of RFieldDft objects (k-space fields) to file.
bool readFieldsRGrid(std::istream &in, DArray< RField< D > > &fields, UnitCell< D > &unitCell) const override
Read array of RField objects (r-grid fields) from a stream.
void convertBasisToKGrid(DArray< double > const &components, RFieldDft< D > &dft) const override
Convert a field from symmetrized basis to Fourier grid (k-grid).
void readFieldsRGridData(std::istream &in, DArray< RField< D > > &fields, int nMonomer) const override
Read data for an array of r-grid fields, with no header section.
FieldIoReal< D, RField< D >, RFieldDft< D >, FFT< D > > Base
Alias for base class.
void readFieldsKGrid(std::istream &in, DArray< RFieldDft< D > > &fields, UnitCell< D > &unitCell) const override
Read array of RFieldDft objects (k-space fields) from a stream.
void convertKGridToBasis(RFieldDft< D > const &in, DArray< double > &out, bool checkSymmetry=true, double epsilon=1.0e-8) const override
Convert a field from Fourier (k-grid) to symmetrized basis form.
void writeFieldsRGrid(std::ostream &out, DArray< RField< D > > const &fields, UnitCell< D > const &unitCell, bool writeHeader=true, bool isSymmetric=true, bool writeMeshSize=true) const override
Write array of RField objects (fields on r-space grid) to a stream.
void writeFieldRGrid(std::ostream &out, RField< D > const &field, UnitCell< D > const &unitCell, bool writeHeader=true, bool isSymmetric=true) const override
Write a single RField (field on an r-space grid) to a stream.
bool readFieldRGrid(std::istream &in, RField< D > &field, UnitCell< D > &unitCell) const override
Read a single RField (field on an r-space grid) from a stream.
Dynamically allocatable contiguous array template.
Definition DArray.h:32
A FileMaster manages input and output files for a simulation.
Definition FileMaster.h:143
Fields and FFTs for periodic boundary conditions (CPU)
Definition CField.cpp:12
Periodic fields and crystallography.
Definition CField.cpp:11
Real periodic fields, SCFT and PS-FTS (CPU).
Definition param_pc.dox:2
PSCF package top-level namespace.
Definition param_pc.dox:1
Utility classes for scientific computation.