Digital Image Correlation Engine  Version 1.0
A modular, high-performance, image correlation tool used to compute full-field displacements and strains from digital images
Public Member Functions | Private Attributes | List of all members
DICe::Affine_Shape_Function Class Reference

six parameter seperable shape function (individual modes can be turned on or off More...

#include <DICe_LocalShapeFunction.h>

Inheritance diagram for DICe::Affine_Shape_Function:
DICe::Local_Shape_Function

Public Member Functions

 Affine_Shape_Function (Schema *schema)
 
 Affine_Shape_Function (const bool enable_rotation, const bool enable_normal_strain, const bool enable_shear_strain, const scalar_t &delta_disp=1.0, const scalar_t &delta_theta=0.1)
 
void init (const bool enable_rotation, const bool enable_normal_strain, const bool enable_shear_strain, const scalar_t &delta_disp=1.0, const scalar_t &delta_theta=0.1)
 
virtual ~Affine_Shape_Function ()
 virtual destructor
 
virtual void initialize_parameters_from_fields (Schema *schema, const int_t subset_gid)
 see base class description
 
virtual void map (const scalar_t &x, const scalar_t &y, const scalar_t &cx, const scalar_t &cy, scalar_t &out_x, scalar_t &out_y)
 see base class description
 
virtual void add_translation (const scalar_t &u, const scalar_t &v)
 see base class description
 
virtual void map_to_u_v_theta (const scalar_t &cx, const scalar_t &cy, scalar_t &out_u, scalar_t &out_v, scalar_t &out_theta)
 see base class description
 
virtual void insert_motion (const scalar_t &u, const scalar_t &v, const scalar_t &theta)
 see base class description
 
virtual void insert_motion (const scalar_t &u, const scalar_t &v)
 see base class description
 
virtual void residuals (const scalar_t &x, const scalar_t &y, const scalar_t &cx, const scalar_t &cy, const scalar_t &gx, const scalar_t &gy, std::vector< scalar_t > &residuals, const bool use_ref_grads=false)
 see base class description
 
virtual bool test_for_convergence (const std::vector< scalar_t > &old_parameters, const scalar_t &tol)
 see base class description
 
virtual void update_params_for_centroid_change (const scalar_t &delta_x, const scalar_t &delta_y)
 see base class description
 
- Public Member Functions inherited from DICe::Local_Shape_Function
 Local_Shape_Function ()
 base class constructor
 
virtual ~Local_Shape_Function ()
 virtual destructor
 
int_t num_params () const
 the number of parameters in the shape function
 
std::vector< scalar_t > * parameters ()
 access to the parameter values
 
void print_parameters () const
 print the parameter values to DEBUG_MSG
 
virtual void save_fields (Schema *schema, const int_t subset_gid)
 
virtual void reset_fields (Schema *schema)
 
void clone (Teuchos::RCP< Local_Shape_Function > shape_function)
 
virtual void clear ()
 clear the parameters
 
scalar_toperator() (const DICe::field_enums::Field_Spec &spec)
 
scalar_toperator() (const size_t index)
 
scalar_t parameter (const DICe::field_enums::Field_Spec &spec) const
 
void update (const std::vector< scalar_t > &update)
 
Teuchos::RCP< std::vector< scalar_t > > rcp ()
 
Teuchos::RCP< std::vector< scalar_t > > deltas ()
 returns a pointer to the vector of delta values for this shape function
 
std::map< DICe::field_enums::Field_Spec, size_t > * spec_map ()
 returns a pointer to the spec map
 

Private Attributes

bool has_rotz_ = false
 flags used to turn off certain parameters in the shape function
 
bool has_nsxx_ = false
 
bool has_nsyy_ = false
 
bool has_ssxy_ = false
 
int dx_ind_ = -1
 index of the shape function parameter in the parameters list
 
int dy_ind_ = -1
 
int rotz_ind_ = -1
 
int nsxx_ind_ = -1
 
int nsyy_ind_ = -1
 
int ssxy_ind_ = -1
 

Additional Inherited Members

- Protected Attributes inherited from DICe::Local_Shape_Function
std::vector< scalar_tparameters_
 a vector that holds the parameters of the shape function
 
std::vector< scalar_tdeltas_
 a vector that holds the deltas to use for a simplex method
 
int_t num_params_
 the total number of degrees of freedom
 
std::map< DICe::field_enums::Field_Spec, size_t > spec_map_
 stores the associated field with each DOF and the corresponding parameter index
 

Detailed Description

six parameter seperable shape function (individual modes can be turned on or off

Constructor & Destructor Documentation

◆ Affine_Shape_Function() [1/2]

DICe::Affine_Shape_Function::Affine_Shape_Function ( Schema schema)

constructor

Parameters
schemapointer to a schema used to initialize the shape function

◆ Affine_Shape_Function() [2/2]

DICe::Affine_Shape_Function::Affine_Shape_Function ( const bool  enable_rotation,
const bool  enable_normal_strain,
const bool  enable_shear_strain,
const scalar_t delta_disp = 1.0,
const scalar_t delta_theta = 0.1 
)

constructor with no schema, but boolean flags instead

Parameters
enable_rotationtrue if rotation parameter should be included
enable_normal_straintrue if normal strain should be included
enable_shear_straintrue if shear strain should be included

Member Function Documentation

◆ init()

void DICe::Affine_Shape_Function::init ( const bool  enable_rotation,
const bool  enable_normal_strain,
const bool  enable_shear_strain,
const scalar_t delta_disp = 1.0,
const scalar_t delta_theta = 0.1 
)

initializes the affine shape function

Parameters
enable_rotationtrue if rotation parameter should be included
enable_normal_straintrue if normal strain should be included
enable_shear_straintrue if shear strain should be included
delta_dispthe displacement delta to use for simplex optimization
delta_thetathe rotation delta to use for simplex optimization