swSim  Version 1.0
All Classes Namespaces Files Functions Variables Typedefs Macros
Classes | Public Member Functions | Public Attributes | List of all members
swSim::Geometry Class Reference

Defines data structures for Geometry in swSim. More...

#include "include/Geometry.hpp"

Inheritance diagram for swSim::Geometry:
swSim::ParsableObject

Classes

struct  geometry_s
 

Public Member Functions

 Geometry ()
 Create the Geometry. More...
 
 ~Geometry ()
 Destroy the Geometry. More...
 
void Init (uint64_t *nVox, double *ds, const char *gFname, const char *rFname)
 Initilize data values with a 3 values for voxel size. More...
 
void Init (uint64_t *nVox, double ds, const char *gFname, const char *rFname)
 Initilize data values with a 1 value for voxel size, so that voxels are cubes. More...
 
void Copy (Geometry *other)
 Copy values of one Geometry to another. More...
 
MPI_Datatype MPICreate ()
 Create the MPI datatype for the Geometry. More...
 
void ParseSwitch (xmlDocPtr doc, xmlNodePtr cur, int caseNumber) override
 Provide parsing instructions for reading inputs associated with the Geometry. More...
 
std::string GetGeometryFile (std::string path)
 Get Geometry file and path as one string. More...
 
std::string GetPlaneCountFile (std::string path)
 Get Plane Count file and path as one string. More...
 
std::string GetRotationsFile (std::string path)
 Get Rotations file and path as one string. More...
 
- Public Member Functions inherited from swSim::ParsableObject
void Parse (xmlDocPtr doc, xmlNodePtr cur)
 Parse the specific object. More...
 
xmlNodePtr ParseSearch (xmlDocPtr doc, xmlNodePtr cur, const char *value)
 Search to the xml element corespondng to each parsable variable. More...
 
void Do_parse (xmlDocPtr doc, xmlNodePtr cur, double *value)
 Parse a double object. More...
 
void Do_parse (xmlDocPtr doc, xmlNodePtr cur, float *value)
 Parse a float object. More...
 
void Do_parse (xmlDocPtr doc, xmlNodePtr cur, uint8_t *value)
 Parse a uint_8 object. More...
 
void Do_parse (xmlDocPtr doc, xmlNodePtr cur, uint32_t *value)
 Parse a uint_32 object. More...
 
void Do_parse (xmlDocPtr doc, xmlNodePtr cur, uint64_t *value)
 Parse a uint_64 object. More...
 
void Do_parse (xmlDocPtr doc, xmlNodePtr cur, bool *value)
 Parse a boolean object. More...
 
void Do_parse (xmlDocPtr doc, xmlNodePtr cur, char *value)
 Parse a char array object. More...
 

Public Attributes

geometry_s geomS
 Geometry struct. More...
 
MPI_Datatype mpi_geometry
 MPI datatype for communication. More...
 
- Public Attributes inherited from swSim::ParsableObject
std::vector< std::string > parseNames
 Vector of parse names to look for when reading inputs. More...
 

Detailed Description

Defines data structures for Geometry in swSim.

Constructor & Destructor Documentation

◆ Geometry()

swSim::Geometry::Geometry ( )

Create the Geometry.

◆ ~Geometry()

swSim::Geometry::~Geometry ( )

Destroy the Geometry.

Member Function Documentation

◆ Init() [1/2]

void swSim::Geometry::Init ( uint64_t *  nVox,
double *  ds,
const char *  gFname,
const char *  rFname 
)

Initilize data values with a 3 values for voxel size.

◆ Init() [2/2]

void swSim::Geometry::Init ( uint64_t *  nVox,
double  ds,
const char *  gFname,
const char *  rFname 
)

Initilize data values with a 1 value for voxel size, so that voxels are cubes.

◆ Copy()

void swSim::Geometry::Copy ( Geometry other)

Copy values of one Geometry to another.

◆ MPICreate()

MPI_Datatype swSim::Geometry::MPICreate ( )

Create the MPI datatype for the Geometry.

◆ ParseSwitch()

void swSim::Geometry::ParseSwitch ( xmlDocPtr  doc,
xmlNodePtr  cur,
int  caseNumber 
)
overridevirtual

Provide parsing instructions for reading inputs associated with the Geometry.

Reimplemented from swSim::ParsableObject.

◆ GetGeometryFile()

std::string swSim::Geometry::GetGeometryFile ( std::string  path)

Get Geometry file and path as one string.

◆ GetPlaneCountFile()

std::string swSim::Geometry::GetPlaneCountFile ( std::string  path)

Get Plane Count file and path as one string.

◆ GetRotationsFile()

std::string swSim::Geometry::GetRotationsFile ( std::string  path)

Get Rotations file and path as one string.

Member Data Documentation

◆ geomS

geometry_s swSim::Geometry::geomS

Geometry struct.

◆ mpi_geometry

MPI_Datatype swSim::Geometry::mpi_geometry

MPI datatype for communication.


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