NuTo
Numerics Tool
Public Types | Public Member Functions | List of all members
NuTo::Specimen Class Reference

class for Specimen More...

#include <Specimen.h>

Public Types

enum  eSpecimenType { Box = 0, Dogbone = 1, Cylinder = 2 }
 

Public Member Functions

 Specimen (Eigen::MatrixXd rBoundingBox, const eSpecimenType rTypeOfSpecimen)
 constructor More...
 
 Specimen (const NuTo::Specimen &rOther)
 copy constructor More...
 
bool IsBox () const
 
const Eigen::MatrixXd & GetBoundingBox () const
 getter for mBoundingBox More...
 
const Eigen::VectorXd & GetLength () const
 getter for mLength More...
 
double GetLength (const int rIndex) const
 getter for specific element mLength[rIndex] More...
 
eSpecimenType GetTypeOfSpecimen () const
 getter of mTypeOfSpecimen More...
 
double GetVolume () const
 calculates and returns specimen volume More...
 

Detailed Description

class for Specimen

Member Enumeration Documentation

Enumerator
Box 
Dogbone 
Cylinder 

Constructor & Destructor Documentation

NuTo::Specimen::Specimen ( Eigen::MatrixXd  rBoundingBox,
const eSpecimenType  rTypeOfSpecimen 
)

constructor

Parameters
rBoundingBoxbounding box of the specimen
rTypeOfSpecimenelement of enum Specimen::Type
NuTo::Specimen::Specimen ( const NuTo::Specimen rOther)

copy constructor

Member Function Documentation

const Eigen::MatrixXd & NuTo::Specimen::GetBoundingBox ( ) const

getter for mBoundingBox

const Eigen::VectorXd & NuTo::Specimen::GetLength ( ) const

getter for mLength

double NuTo::Specimen::GetLength ( const int  rIndex) const

getter for specific element mLength[rIndex]

NuTo::Specimen::eSpecimenType NuTo::Specimen::GetTypeOfSpecimen ( ) const

getter of mTypeOfSpecimen

double NuTo::Specimen::GetVolume ( ) const

calculates and returns specimen volume

bool NuTo::Specimen::IsBox ( ) const

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