ls1-MarDyn
ls1-MarDyn molecular dynamics code
Public Member Functions | List of all members
Coordinate3D Class Reference

The Coordinate3D class eases the handling of x y z coordinates in xml input. More...

#include <Coordinate3D.h>

Public Member Functions

 Coordinate3D (XMLfileUnits &xmlconfig, std::string nodename=std::string("."))
 constructor directly reading in xml structure More...
 
void readXML (XMLfileUnits &xmlconfig)
 Read in XML configuration for x y z coordinate. More...
 
double x ()
 Get x component of coordinate.
 
double y ()
 Get y component of coordinate.
 
double z ()
 Get z component of coordinate.
 
void get (double vec[3])
 obtain coordinate vector values
 

Detailed Description

The Coordinate3D class eases the handling of x y z coordinates in xml input.

Constructor & Destructor Documentation

◆ Coordinate3D()

Coordinate3D::Coordinate3D ( XMLfileUnits xmlconfig,
std::string  nodename = std::string(".") 
)

constructor directly reading in xml structure

Parameters
[in]xmlconfigxml config file object
[in]nodenamenode path holding the x y z structure to be parsed by readXML

Member Function Documentation

◆ readXML()

void Coordinate3D::readXML ( XMLfileUnits xmlconfig)

Read in XML configuration for x y z coordinate.

The following xml object structure is handled by this method:

<x>DOUBLE</x>
<y>DOUBLE</y>
<z>DOUBLE</z>
Note
values are processed with units

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