NswAsBuilt::ElementModelScaleSag Class Reference

An element model implementing the deformations used for the NSW MM as-built parameters. More...

#include <ElementModelScaleSag.h>

Inheritance diagram for NswAsBuilt::ElementModelScaleSag:

Collaboration diagram for NswAsBuilt::ElementModelScaleSag:

Public Types
enum	parameter_t {   X =0, Y =1, Z =2, THX =3,   THY =4, THZ =5, EGX =6, EGY =7,   EGZ =8, SAGX =9, SAGY =10, DEGX =11,   DEGY =12, PGX =13, PGY =14, DSAGX =15,   DSAGY =16 }
using	ipar_t = unsigned int
using	VectorSet = Eigen::Matrix< double, 3, Eigen::Dynamic, Eigen::ColMajor|Eigen::AutoAlign, 3, 5 >
using	VectorSetRef = Eigen::Ref< VectorSet >

Public Member Functions
	ElementModelScaleSag (double lenX, double lenY, Amg::Vector3D defo0)
	ElementModelScaleSag ()=delete
virtual int	nParameters () const override
virtual void	transform (const ParameterVector &parvec, VectorSetRef local) const override
	Transform a set of vectors expressed in local frame, stored in a matrix. More...
virtual void	cacheTransform (ParameterVector &parvec) const override
	Cache the rigid component of this deformation model. More...
virtual ipar_t	getParameterIndex (const std::string &parname) const override
virtual std::string	getParameterName (ipar_t ipar) const override

Private Member Functions
void	applyDeformation (const ParameterVector &parvec, Eigen::Ref< Amg::Vector3D > local) const
void	applyDeformation2 (const ParameterVector &parvec, VectorSetRef local) const
Amg::Vector3D	DSagX (double sagx, const Amg::Vector3D &d0) const
Amg::Vector3D	DSagY (double sagy, const Amg::Vector3D &d0) const
Amg::Vector3D	DDSagX (double dsagx, const Amg::Vector3D &d0) const
Amg::Vector3D	DDSagY (double dsagy, const Amg::Vector3D &d0) const
Amg::Vector3D	DDegX (double degx, const Amg::Vector3D &d0) const
Amg::Vector3D	DDegY (double degy, const Amg::Vector3D &d0) const
Amg::Vector3D	DPgX (double pgx, const Amg::Vector3D &d0) const
Amg::Vector3D	DPgY (double pgy, const Amg::Vector3D &d0) const

Static Private Member Functions
static Amg::Vector3D	DEg (double egx, double egy, double egz, const Amg::Vector3D &d0)

Private Attributes
double	m_lenX {0.}
double	m_lenY {0.}
Amg::Vector3D	m_defo0 {Amg::Vector3D::Zero()}

Detailed Description

An element model implementing the deformations used for the NSW MM as-built parameters.

The first 6 parameters represent the rigid component of the transform (a 3D translation and 3 Euler angles to be applied in the order ZYX)

The following parameters are providing deformations, as follows:

• EGX, EGY, EGZ: elongations, expressed in permil units
• SAGX and SAGY: bending along the X and Y directions, expressed in millimeter. SAGY(X) leaves unchanged the points at X(Y) = +- 0.5*lenX(Y), and they move the center point by SAGY(X), respectively
• DEGX, DEGY: gradients en elongation along X and Y. The elongation along Y(X) at points X(Y) = +- 0.5*lenX(Y) is EGY(X)+-DEGY(X), respectively. Expressed in permil units.
• PGX, PGY: Paralellogram (shear) transforms, expressed in millimeters. PGX(Y) is the displacement along X(Y) of point at Y(X)=0.5*lenY(X). Central point is not moved
• DSAGX, DSAGY: gradients of sag along X and Y. sag along Y(X) at Y(X)=0 is unchanged by this transform, and is increased by DSAGY(X) at Y(X)=0.5*lenY

Definition at line 35 of file ElementModelScaleSag.h.

Member Typedef Documentation

ipar_t

using NswAsBuilt::ElementModel::ipar_t = unsigned int

inherited

Definition at line 35 of file ElementModel.h.

VectorSet

using NswAsBuilt::ElementModel::VectorSet = Eigen::Matrix<double, 3, Eigen::Dynamic, Eigen::ColMajor|Eigen::AutoAlign, 3, 5>

inherited

Definition at line 36 of file ElementModel.h.

VectorSetRef

using NswAsBuilt::ElementModel::VectorSetRef = Eigen::Ref<VectorSet>

inherited

Definition at line 37 of file ElementModel.h.

Member Enumeration Documentation

parameter_t

enum NswAsBuilt::ElementModelScaleSag::parameter_t

Enumerator
X
Y
Z
THX
THY
THZ
EGX
EGY
EGZ
SAGX
SAGY
DEGX
DEGY
PGX
PGY
DSAGX
DSAGY

Definition at line 37 of file ElementModelScaleSag.h.

                       {
        X=0,
        Y=1,
        Z=2,
        THX=3,
        THY=4,
        THZ=5,
        EGX=6,
        EGY=7,
        EGZ=8,
        SAGX=9,
        SAGY=10,
        DEGX=11,
        DEGY=12,
        PGX=13,
        PGY=14,
        DSAGX=15,
        DSAGY=16
      };

Constructor & Destructor Documentation

ElementModelScaleSag() [1/2]

ElementModelScaleSag::ElementModelScaleSag	(	double	lenX,
		double	lenY,
		Amg::Vector3D	defo0
	)

Definition at line 14 of file ElementModelScaleSag.cxx.

: m_lenX(lenX), m_lenY(lenY), m_defo0(std::move(defo0))
{ }

ElementModelScaleSag() [2/2]

NswAsBuilt::ElementModelScaleSag::ElementModelScaleSag ( )

delete

Member Function Documentation

applyDeformation()

void ElementModelScaleSag::applyDeformation ( const ParameterVector &  parvec, Eigen::Ref< Amg::Vector3D >  local  ) const

private

Definition at line 195 of file ElementModelScaleSag.cxx.

{
  // Applies the deformation to the set of local vectors given as argument
  // This old-style implementation is the reference implementation
  Amg::Vector3D d0 = local - m_defo0;
  local = local
    + DEg(parvec[EGX], parvec[EGY], parvec[EGZ], d0)
    + DSagX(parvec[SAGX], d0)
    + DSagY(parvec[SAGY], d0)
    + DDSagX(parvec[DSAGX], d0)
    + DDSagY(parvec[DSAGY], d0)
    + DDegX(parvec[DEGX], d0)
    + DDegY(parvec[DEGY], d0)
    + DPgX(parvec[PGX], d0)
    + DPgY(parvec[PGY], d0)
    ;
}

applyDeformation2()

void ElementModelScaleSag::applyDeformation2 ( const ParameterVector &  parvec, VectorSetRef  local  ) const

private

Definition at line 215 of file ElementModelScaleSag.cxx.

{
  // Applies the deformation to the set of local vectors given as argument
  // This implementation uses Eigen-style algebra (does the same as the method applyDeformation above, but benefits from Eigen's optimizations)
 
  // Temporaries allocated on the stack
  // d0 = local - defo0
  VectorSet d0 = local.colwise() - m_defo0;
 
  // r = {d0.x/(0.5*lenX), d0.y/(0.5*lenY), (d0.z)}
  // r.x is (-1,+1) at X=(-0.5*lenX, 0.5*lenX), similarly for Y
  VectorSet r = d0.array().colwise() * Eigen::Array3d{1.0/(0.5*m_lenX), 1.0/(0.5*m_lenY), 1.0};
 
  // p2.{x,y,z} = 1 - r.{x,y,z}^2
  // p2.x = 1 at r.x = 0 and p2.x = 0 at r.x = +-0.5*lenX, similarly for Y
  VectorSet p2 = -1.0*(r.array().square().colwise() - Eigen::Array3d::Ones());
 
  double egx = parvec[EGX];
  double egy = parvec[EGY];
  double egz = parvec[EGZ];
  double sagx = parvec[SAGX];
  double sagy = parvec[SAGY];
  double dsagx = parvec[DSAGX];
  double dsagy = parvec[DSAGY];
  double degx = parvec[DEGX];
  double degy = parvec[DEGY];
  double pgx = parvec[PGX];
  double pgy = parvec[PGY];
 
  // EGX, EGY, EGZ:
  // d0.{x,y,z} * {egx, egy, egz}
  local.array() += d0.array().colwise() * Eigen::Array3d{egx*DivBy1k, egy*DivBy1k, egz*DivBy1k};
 
  // SAGX, SAGY:
  // p2.{y,x} * {sagx, sagy}
  local.topRows<2>().array() += p2.topRows<2>().array().colwise().reverse().colwise() * Eigen::Array2d{sagx, sagy};
 
  // DSAGX, DSAGY:
  // p2.{y,x} * {dsagx*r.x, dsagy*r.y}
  local.topRows<2>().array() += (p2.topRows<2>().array().colwise().reverse() * r.topRows<2>().array()).colwise() * Eigen::Array2d{dsagx, dsagy};
 
  // DEGX, DEGY:
  // d0.{x,y} * {degx*r.y, degy*r.x}
  local.topRows<2>().array() += (d0.topRows<2>().array() * r.topRows<2>().array().colwise().reverse()).colwise() * Eigen::Array2d{degx*DivBy1k, degy*DivBy1k};
 
  // PGX, PGY:
  // r.{y,x} * {pgx, pgy}
  local.topRows<2>().array() += r.topRows<2>().array().colwise().reverse().colwise() * Eigen::Array2d{pgx, pgy};
}

cacheTransform()

void ElementModelScaleSag::cacheTransform ( ParameterVector &  parvec ) const

overridevirtual

Cache the rigid component of this deformation model.

Implements NswAsBuilt::ElementModel.

Definition at line 44 of file ElementModelScaleSag.cxx.

                                                                       {
  const auto& pars = parvec.parameters;
  parvec.transformCache
    = Eigen::Translation3d(pars[X], pars[Y], pars[Z])
    * Eigen::AngleAxisd(pars[THZ], Eigen::Vector3d::UnitZ())
    * Eigen::AngleAxisd(pars[THY], Eigen::Vector3d::UnitY())
    * Eigen::AngleAxisd(pars[THX], Eigen::Vector3d::UnitX());
  parvec.transformCacheValid = true;
}

DDegX()

Amg::Vector3D ElementModelScaleSag::DDegX ( double  degx, const Amg::Vector3D &  d0  ) const

private

Definition at line 161 of file ElementModelScaleSag.cxx.

{
  double egx_eff = degx * d0[1]/(0.5*m_lenY);
  double delta = egx_eff * d0[0]*DivBy1k;
  return Amg::Vector3D(delta, 0., 0.);
}

DDegY()

Amg::Vector3D ElementModelScaleSag::DDegY ( double  degy, const Amg::Vector3D &  d0  ) const

private

Definition at line 170 of file ElementModelScaleSag.cxx.

{
  double egy_eff = degy * d0[0]/(0.5*m_lenX);
  double delta = egy_eff * d0[1]*DivBy1k;
  return Amg::Vector3D(0., delta, 0.);
}

DDSagX()

Amg::Vector3D ElementModelScaleSag::DDSagX ( double  dsagx, const Amg::Vector3D &  d0  ) const

private

Definition at line 137 of file ElementModelScaleSag.cxx.

{
  // Calculate sag along X
  double sagx = dsagx * d0[0]/(0.5*m_lenX);
  double r = d0[1]/(0.5*m_lenY);
  // delta is sagx at y=y0, 0 at y=y0+-0.5*_lenY
  double delta = sagx * (1. - r*r);
  return Amg::Vector3D(delta, 0., 0.);
}

DDSagY()

Amg::Vector3D ElementModelScaleSag::DDSagY ( double  dsagy, const Amg::Vector3D &  d0  ) const

private

Definition at line 149 of file ElementModelScaleSag.cxx.

{
  // Calculate dsag along Y
  double sagy = dsagy * d0[1]/(0.5*m_lenY);
  double r = d0[0]/(0.5*m_lenX);
  // delta is sagY at x=x0, 0 at x=x0+-0.5*_lenX
  double delta = sagy * (1. - r*r);
  return Amg::Vector3D(0., delta, 0.);
}

DEg()

Amg::Vector3D ElementModelScaleSag::DEg ( double  egx, double  egy, double  egz, const Amg::Vector3D &  d0  )

staticprivate

Definition at line 107 of file ElementModelScaleSag.cxx.

{
  // Calculate thermal expansion
  return d0.array() * Eigen::Array3d{egx*DivBy1k, egy*DivBy1k, egz*DivBy1k};
}

DPgX()

Amg::Vector3D ElementModelScaleSag::DPgX ( double  pgx, const Amg::Vector3D &  d0  ) const

private

Definition at line 179 of file ElementModelScaleSag.cxx.

{
  double delta = pgx * d0[1]/(0.5*m_lenY);
  return Amg::Vector3D(delta, 0., 0.);
}

DPgY()

Amg::Vector3D ElementModelScaleSag::DPgY ( double  pgy, const Amg::Vector3D &  d0  ) const

private

Definition at line 187 of file ElementModelScaleSag.cxx.

{
  double delta = pgy * d0[0]/(0.5*m_lenX);
  return Amg::Vector3D(0., delta, 0.);
}

DSagX()

Amg::Vector3D ElementModelScaleSag::DSagX ( double  sagx, const Amg::Vector3D &  d0  ) const

private

Definition at line 115 of file ElementModelScaleSag.cxx.

{
  // Calculate sag along X
  double r = d0[1]/(0.5*m_lenY);
  // delta is sagx at y=y0, 0 at y=y0+-0.5*_lenY
  double delta = sagx * (1. - r*r);
  return Amg::Vector3D(delta, 0., 0.);
}

DSagY()

Amg::Vector3D ElementModelScaleSag::DSagY ( double  sagy, const Amg::Vector3D &  d0  ) const

private

Definition at line 126 of file ElementModelScaleSag.cxx.

{
  // Calculate sag along Y
  double r = d0[0]/(0.5*m_lenX);
  // delta is sagY at x=x0, 0 at x=x0+-0.5*_lenX
  double delta = sagy * (1. - r*r);
  return Amg::Vector3D(0., delta, 0.);
}

getParameterIndex()

ElementModelScaleSag::ipar_t ElementModelScaleSag::getParameterIndex ( const std::string &  parname ) const

overridevirtual

Implements NswAsBuilt::ElementModel.

Definition at line 57 of file ElementModelScaleSag.cxx.

{
  if (parname == "x") return parameter_t::X;
  if (parname == "y") return parameter_t::Y;
  if (parname == "z") return parameter_t::Z;
  if (parname == "thx") return parameter_t::THX;
  if (parname == "thy") return parameter_t::THY;
  if (parname == "thz") return parameter_t::THZ;
  if (parname == "egx") return parameter_t::EGX;
  if (parname == "egy") return parameter_t::EGY;
  if (parname == "egz") return parameter_t::EGZ;
  if (parname == "sagx") return parameter_t::SAGX;
  if (parname == "sagy") return parameter_t::SAGY;
  if (parname == "degx") return parameter_t::DEGX;
  if (parname == "degy") return parameter_t::DEGY;
  if (parname == "pgx") return parameter_t::PGX;
  if (parname == "pgy") return parameter_t::PGY;
  if (parname == "dsagx") return parameter_t::DSAGX;
  if (parname == "dsagy") return parameter_t::DSAGY;
  throw std::runtime_error("Invalid parameter name "+parname);
}

getParameterName()

std::string ElementModelScaleSag::getParameterName ( ipar_t  ipar ) const

overridevirtual

Implements NswAsBuilt::ElementModel.

Definition at line 81 of file ElementModelScaleSag.cxx.

{
  switch (ipar) {
    case X: return "x";
    case Y: return "y";
    case Z: return "z";
    case THX: return "thx";
    case THY: return "thy";
    case THZ: return "thz";
    case EGX: return "egx";
    case EGY: return "egy";
    case EGZ: return "egz";
    case SAGX: return "sagx";
    case SAGY: return "sagy";
    case DEGX: return "degx";
    case DEGY: return "degy";
    case PGX: return "pgx";
    case PGY: return "pgy";
    case DSAGX: return "dsagx";
    case DSAGY: return "dsagy";
    default: throw std::runtime_error("Invalid parameter");
  }
}

nParameters()

virtual int NswAsBuilt::ElementModelScaleSag::nParameters ( ) const

inlineoverridevirtual

Implements NswAsBuilt::ElementModel.

Definition at line 61 of file ElementModelScaleSag.h.

{ return 17; }

transform()

void ElementModelScaleSag::transform ( const ParameterVector &  parvec, VectorSetRef  local  ) const

overridevirtual

Transform a set of vectors expressed in local frame, stored in a matrix.

Implements NswAsBuilt::ElementModel.

Definition at line 21 of file ElementModelScaleSag.cxx.

                                                                                            {
 
  if (!parvec.transformCacheValid) {
    throw std::runtime_error("Should call Element::cacheTransforms() first");
  }
 
  // Apply the deformation component
  /*
   * old-style (reference) implementation: not optimized
  for (int i=0; i< local.cols(); ++i) {
    applyDeformation(parvec, local.col(i));
  }
  */
  // Eigen-style implementation: optimized
  applyDeformation2(parvec, local);
 
  // Apply the rigid component
  local = (parvec.transformCache * local).eval(); // Needs eval to avoid aliasing (?)
}

Member Data Documentation

m_defo0

Amg::Vector3D NswAsBuilt::ElementModelScaleSag::m_defo0 {Amg::Vector3D::Zero()}

private

Definition at line 96 of file ElementModelScaleSag.h.

m_lenX

double NswAsBuilt::ElementModelScaleSag::m_lenX {0.}

private

Definition at line 94 of file ElementModelScaleSag.h.

m_lenY

double NswAsBuilt::ElementModelScaleSag::m_lenY {0.}

private

Definition at line 95 of file ElementModelScaleSag.h.

---

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

• ElementModelScaleSag.h
• ElementModelScaleSag.cxx