Main Page | Namespace List | Class Hierarchy | Class List | File List | Namespace Members | Class Members | File Members

LSMDD::LSMDD_Parameters Class Reference

The LSMDD_Parameters holds physical and simulation parameters that are used by several classes within the Level Set Method Dislocation Dynamics (LSMDD) library. More...

#include <LSMDD_Parameters.h>

List of all members.

Public Member Functions

Constructor and destructor
 LSMDD_Parameters ()
 LSMDD_Parameters (Pointer< Database > input_db)
virtual ~LSMDD_Parameters ()
 LSMDD_Parameters (const LSMDD_Parameters &rhs)
Method for initializing parameters from an Database
virtual void initializeParametersFromDatabase (Pointer< Database >)
Accessor methods for material parameters
virtual void setShearModulus (double shear_modulus)
virtual double getShearModulus () const
virtual void setPoissonRatio (double poisson_ratio)
virtual double getPoissonRatio () const
Accessor methods for dislocation parameters
virtual void setGlideMobility (double glide_mobility)
virtual double getGlideMobility () const
virtual void setClimbMobility (double climb_mobility)
virtual double getClimbMobility () const
virtual void setCoreRadius (double core_radius)
virtual double getCoreRadius () const
Accessor methods for simulation parameters
virtual void activateDebugMode ()
virtual void deactivateDebugMode ()
virtual bool debugOn () const
virtual void setMinDislocationSegmentLength (double min_dislocation_segment_length)
virtual double getMinDislocationSegmentLength () const
virtual void setMaxAngleForPureScrew (double max_angle_for_pure_screw)
virtual double getMaxAngleForPureScrew () const
Utility Methods
virtual void printClassData (ostream &os) const
Operators
virtual const LSMDD_Parametersoperator= (const LSMDD_Parameters &rhs)

Protected Attributes

double d_shear_modulus
double d_poisson_ratio
double d_glide_mobility
double d_climb_mobility
double d_core_radius
double d_min_dislocation_segment_length
double d_max_angle_for_pure_screw
bool d_lsmdd_debug_on


Detailed Description

The LSMDD_Parameters holds physical and simulation parameters that are used by several classes within the Level Set Method Dislocation Dynamics (LSMDD) library.

User-specified parameters (input database field)

When using the LSMDD_Parameters, it is possible to modify the data stored in the module through an input file. The input data parameters available for/required by the user are described below. In the input file, the parameters for the components of the The input file should have the following form:

LSMDD_Parameters {

... input parameters for LSMDD_Parameters ...

} // end input database for LSMDD_Parameters

LSMDD_Parameters Input Database Parameters

Sample Input File

++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ LSMDD_Parameters {

// elasticity parameters shear_modulus = 1.0 poisson_ratio = 0.33

// dislocation parameters glide_mobility = 1.0 climb_mobility = 0.1 core_radius = 3

// numerical parameters min_dislocation_segment_length = 1.0e-6 max_angle_for_pure_screw = 0.1

// debug parameters debug_on = TRUE

} // end of DislocationDynanmicsModule database

++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++

NOTES


Constructor & Destructor Documentation

LSMDD::LSMDD_Parameters::LSMDD_Parameters  )  [inline]
 

The default constructor initializes the class with default (physically meaningless) parameters.

Arguments: none

LSMDD::LSMDD_Parameters::LSMDD_Parameters Pointer< Database >  input_db  ) 
 

The constructor initializes the class from the specified input database.

Arguments:

  • input_db (in): input database containing user-defined parameters for the LSMDD_Parameters

virtual LSMDD::LSMDD_Parameters::~LSMDD_Parameters  )  [inline, virtual]
 

The destructor does nothing.

LSMDD::LSMDD_Parameters::LSMDD_Parameters const LSMDD_Parameters rhs  )  [inline]
 

The copy constructor sets the new LSMDD_Parameters equal to the specified LSMDD_Parameters object.

Arguments:


Member Function Documentation

virtual void LSMDD::LSMDD_Parameters::activateDebugMode  )  [inline, virtual]
 

activateDebugMode() activates debug mode.

Arguments: none

Return value: none

virtual void LSMDD::LSMDD_Parameters::deactivateDebugMode  )  [inline, virtual]
 

deactivateDebugMode() deactivates debug mode.

Arguments: none

Return value: none

virtual bool LSMDD::LSMDD_Parameters::debugOn  )  const [inline, virtual]
 

debugOn() returns true if debugging is activated; returns false otherwise.

Arguments: none

Return value: debug mode

virtual double LSMDD::LSMDD_Parameters::getClimbMobility  )  const [inline, virtual]
 

getClimbMobility() returns the climb mobility for dislocations.

Arguments: none

Return value: climb mobility

virtual double LSMDD::LSMDD_Parameters::getCoreRadius  )  const [inline, virtual]
 

getCoreRadius() returns the core radius for dislocations.

Arguments: none

Return value: core radius

virtual double LSMDD::LSMDD_Parameters::getGlideMobility  )  const [inline, virtual]
 

getGlideMobility() returns the glide mobility for dislocations.

Arguments: none

Return value: glide mobility

virtual double LSMDD::LSMDD_Parameters::getMaxAngleForPureScrew  )  const [inline, virtual]
 

getMaxAngleForPureScrew() returns the maximum angle between the Burgers vector and tangent vector for considering a dislocation line segment to have pure screw character.

Arguments: none

Return value: maximum angle for segment to be considered pure screw

virtual double LSMDD::LSMDD_Parameters::getMinDislocationSegmentLength  )  const [inline, virtual]
 

getMinDislocationSegmentLength() returns the minimum dislocation segment length in order to consider the two end points of the segment to be numerically distinct.

Arguments: none

Return value: minimum dislocation segment length

virtual double LSMDD::LSMDD_Parameters::getPoissonRatio  )  const [inline, virtual]
 

getPoissonRatio() returns the Poisson ratio for the material.

Arguments: none

Return value: Poisson ratio

virtual double LSMDD::LSMDD_Parameters::getShearModulus  )  const [inline, virtual]
 

getShearModulus() returns the shear modulus for the material.

Arguments: none

Return value: shear modulus

virtual void LSMDD::LSMDD_Parameters::initializeParametersFromDatabase Pointer< Database >   )  [virtual]
 

initializeParametersFromDatabase() sets the dislocation dynamics parameters from the specified database.

Arguments:

  • database (in): pointer to Database containing parameters

Return value: none

virtual const LSMDD_Parameters& LSMDD::LSMDD_Parameters::operator= const LSMDD_Parameters rhs  )  [inline, virtual]
 

The assignment operator sets the new LSMDD_Parameters equal to the specified LSMDD_Parameters object.

Arguments:

Return value: reference to the new LSMDD_Parameters

virtual void LSMDD::LSMDD_Parameters::printClassData ostream &  os  )  const [virtual]
 

printClassData() prints the value of the data members for an instance of the LSMDD_Parameters class.

Arguments:

  • os (in): output stream to write object information

Return value: none

virtual void LSMDD::LSMDD_Parameters::setClimbMobility double  climb_mobility  )  [inline, virtual]
 

setClimbMobility() sets the climb mobility for dislocations.

Arguments:

  • climb_mobility (in): climb mobility

Return value: none

virtual void LSMDD::LSMDD_Parameters::setCoreRadius double  core_radius  )  [inline, virtual]
 

setCoreRadius() sets the core radius for dislocations.

Arguments:

  • core_radius (in): core radius

Return value: none

virtual void LSMDD::LSMDD_Parameters::setGlideMobility double  glide_mobility  )  [inline, virtual]
 

setGlideMobility() sets the glide mobility for dislocations.

Arguments:

  • glide_mobility (in): glide mobility

Return value: none

virtual void LSMDD::LSMDD_Parameters::setMaxAngleForPureScrew double  max_angle_for_pure_screw  )  [inline, virtual]
 

setMaxAngleForPureScrew() sets the maximum angle between the Burgers vector and tangent vector for considering a dislocation line segment to have pure screw character.

Arguments:

  • max_angle_for_pure_screw (in): maximum angle for segment to be considered pure screw

Return value: none

virtual void LSMDD::LSMDD_Parameters::setMinDislocationSegmentLength double  min_dislocation_segment_length  )  [inline, virtual]
 

setMinDislocationSegmentLength() sets the minimum dislocation segment length in order to consider the two end points of the segment to be numerically distinct.

Arguments:

  • min_dislocation_segment_length (in): minimum dislocation segement length

Return value: none

virtual void LSMDD::LSMDD_Parameters::setPoissonRatio double  poisson_ratio  )  [inline, virtual]
 

setPoissonRatio() sets the Poisson ratio for the material.

Arguments:

  • poisson_ratio (in): Poisson ratio

Return value: none

virtual void LSMDD::LSMDD_Parameters::setShearModulus double  shear_modulus  )  [inline, virtual]
 

setShearModulus() sets the shear modulus for the material.

Arguments:

  • shear_modulus (in): shear modulus

Return value: none


Member Data Documentation

double LSMDD::LSMDD_Parameters::d_climb_mobility [protected]
 

double LSMDD::LSMDD_Parameters::d_core_radius [protected]
 

double LSMDD::LSMDD_Parameters::d_glide_mobility [protected]
 

bool LSMDD::LSMDD_Parameters::d_lsmdd_debug_on [protected]
 

double LSMDD::LSMDD_Parameters::d_max_angle_for_pure_screw [protected]
 

double LSMDD::LSMDD_Parameters::d_min_dislocation_segment_length [protected]
 

double LSMDD::LSMDD_Parameters::d_poisson_ratio [protected]
 

double LSMDD::LSMDD_Parameters::d_shear_modulus [protected]
 


The documentation for this class was generated from the following file:
Generated on Tue Aug 7 15:43:41 2007 for LSMDD by doxygen 1.3.4