present_field.h

// -*-c++-*-
#ifndef STORMM_PRESENT_FIELD_H
#define STORMM_PRESENT_FIELD_H
 
#include <fstream>
#include <iostream>
#include <limits.h>
#include "copyright.h"
#include "Constants/behavior.h"
#include "Constants/symbol_values.h"
#include "DataTypes/common_types.h"
#include "FileManagement/file_enumerators.h"
#include "FileManagement/file_listing.h"
#include "FileManagement/file_util.h"
#include "Math/math_enumerators.h"
#include "Math/rounding.h"
#include "Math/tickcounter.h"
#include "Parsing/polynumeric.h"
#include "Structure/background_mesh.h"
#include "Structure/mesh_mechanics.h"
#include "Structure/mesh_parameters.h"
#include "Structure/structure_enumerators.h"
#include "Topology/atomgraph_abstracts.h"
#include "Trajectory/coordinate_copy.h"
#include "Trajectory/coordinateframe.h"
#include "Trajectory/coordinate_series.h"
#include "reporting_enumerators.h"
#include "render_molecule.h"
#include "render_options.h"
#include "summary_file.h"
 
namespace stormm {
namespace review {
 
using constants::ExceptionResponse;
using diskutil::openOutputFile;
using diskutil::PrintSituation;
using diskutil::splitPath;
using parse::findAlignmentWidth;
using parse::intToString;
using parse::NumberFormat;
using parse::PolyNumeric;
using parse::realToString;
using stmath::LimitApproach;
using stmath::nearestFactor;
using stmath::primeFactors;
using stmath::TickCounter;
using structure::BackgroundMesh;
using structure::BackgroundMeshReader;
using structure::BoundaryCondition;
using structure::getEnumerationName;
using structure::interpolate;
using structure::MeshFFKit;
using structure::MeshFoundation;
using structure::MeshParameters;
using structure::MeshParamKit;
using structure::NonbondedPotential;
using structure::OffMeshProtocol;
using symbols::angstrom_to_bohr;
using topology::ChemicalDetailsKit;
using topology::NonbondedKit;
using trajectory::coordCopy;
using trajectory::CoordinateFrame;
using trajectory::CoordinateFrameReader;
using trajectory::CoordinateSeries;

constexpr int default_scene_decimal_places = 5;
constexpr char default_border_path_var[] = "border_path";

std::string getSceneDataFileName(const std::string &scene_file);

std::string drawFieldBorders(const MeshParameters &mps, const RenderOptions &ropt,
                             GridFileSyntax syntax,
                             const std::string &path_name = std::string(default_border_path_var)); 
 
void drawFieldBorders(std::ofstream *foutp, const MeshParameters &mps, const RenderOptions &ropt,
                      GridFileSyntax syntax,
                      const std::string &path_name = std::string(default_border_path_var)); 

template <typename T>
void printToFile(const BackgroundMesh<T> &bgm, const MeshParameters &mps,
                 const std::string &file_name, PrintSituation expectation, GridFileSyntax syntax,
                 const RenderOptions &ropt = RenderOptions(), int decimal_places = 5,
                 ExceptionResponse policy = ExceptionResponse::WARN);
 
template <typename T>
void printToFile(const BackgroundMesh<T> &bgm, const std::string &file_name,
                 PrintSituation expectation, GridFileSyntax syntax,
                 const RenderOptions &ropt = RenderOptions(), int decimal_places = 5,
                 ExceptionResponse policy = ExceptionResponse::WARN);
 
} // namespace review
} // namespace stormm
 
#include "present_field.tpp"
 
#endif