geom::ParticleTransform Struct Reference

A struct that stores transformation parameters and provides method to transform the particle. Basically, given a reference particle, this provides method to translate, rotate, and scale the reference particle. More...

#include <particleTransform.h>

Collaboration diagram for geom::ParticleTransform:

Public Member Functions
	ParticleTransform ()
	Constructor.
	ParticleTransform (util::Point translate, util::Point axis, double theta, double scale=1.)
	Constructor with pivot at origin (reference mesh centered at origin).
	ParticleTransform (util::Point translate, util::Point axis, double theta, double scale, util::Point rotation_point)
	Constructor with explicit rotation pivot (consistent with GeomObject::transform).
	ParticleTransform (const ParticleTransform &t)
	Copy constructor.
util::Point	apply (const util::Point &v) const
	Maps a reference-configuration point \(\mathbf v\) to world coordinates using the same rule as geom::mapSimilarity / GeomObject::transform: \(\mathbf y = \mathbf p + s\,\mathbf R(\mathbf v-\mathbf p) + \mathbf t\).
std::string	printStr (int nt=0, int lvl=0) const
	Returns the string containing printable information about the object.
void	print (int nt=0, int lvl=0) const
	Prints the information about the object.

Data Fields
util::Point	d_translation
	Rigid translation \(\mathbf t\) after rotate+scale about the pivot (matches GeomObject::transform).
util::Point	d_axis
	Unit axis of rotation.
double	d_theta
	Angle of rotation (radians)
double	d_scale
	Uniform scale factor.
util::Point	d_rotationPoint
	Pivot \(\mathbf p\) for rotation and scale (same role as rotationPoint in GeomObject::transform). Default origin for legacy meshes centered at zero.

Detailed Description

A struct that stores transformation parameters and provides method to transform the particle. Basically, given a reference particle, this provides method to translate, rotate, and scale the reference particle.

Definition at line 26 of file particleTransform.h.

Constructor & Destructor Documentation

ParticleTransform() [1/4]

geom::ParticleTransform::ParticleTransform ( )

inline

Constructor.

Default constructor creates identity transformation, i.e. transform(x) = x.

Definition at line 48 of file particleTransform.h.

      : d_translation(util::Point()), d_axis(util::Point()),
        d_theta(0.), d_scale(1.), d_rotationPoint(util::Point()){};

ParticleTransform() [2/4]

geom::ParticleTransform::ParticleTransform ( util::Point  translate, util::Point  axis, double  theta, double  scale = 1.  )

inline

Constructor with pivot at origin (reference mesh centered at origin).

Parameters

translate	Translation vector \(\mathbf t\)
axis	Axis of rotation
theta	Angle of rotation
scale	Uniform scale

Definition at line 60 of file particleTransform.h.

      : d_translation(translate), d_axis(axis / axis.length()), d_theta(theta),
        d_scale(scale), d_rotationPoint(util::Point()){};

ParticleTransform() [3/4]

geom::ParticleTransform::ParticleTransform ( util::Point  translate, util::Point  axis, double  theta, double  scale, util::Point  rotation_point  )

inline

Constructor with explicit rotation pivot (consistent with GeomObject::transform).

Definition at line 68 of file particleTransform.h.

      : d_translation(translate), d_axis(axis / axis.length()), d_theta(theta),
        d_scale(scale), d_rotationPoint(rotation_point){};

ParticleTransform() [4/4]

geom::ParticleTransform::ParticleTransform ( const ParticleTransform &  t )

inline

Copy constructor.

Parameters

t	Another ParticleTransform object

Definition at line 77 of file particleTransform.h.

      : d_translation(t.d_translation), d_axis(t.d_axis),
        d_theta(t.d_theta), d_scale(t.d_scale), d_rotationPoint(t.d_rotationPoint){};

Member Function Documentation

apply()

util::Point geom::ParticleTransform::apply ( const util::Point &  v ) const

inline

Maps a reference-configuration point \(\mathbf v\) to world coordinates using the same rule as geom::mapSimilarity / GeomObject::transform: \(\mathbf y = \mathbf p + s\,\mathbf R(\mathbf v-\mathbf p) + \mathbf t\).

When \(\mathbf p = \mathbf 0\), this reduces to \(\mathbf y = s\,\mathbf R(\mathbf v) + \mathbf t\) (legacy reference-mesh-at-origin case).

Parameters

v	Node position in reference particle frame

Returns

Transformed position

Definition at line 92 of file particleTransform.h.

                                            {
    return d_rotationPoint +
           d_scale * util::rotate(v - d_rotationPoint, d_theta, d_axis) +
           d_translation;
  };

References d_axis, d_rotationPoint, d_scale, d_theta, d_translation, and util::rotate().

Referenced by particle::BaseParticle::BaseParticle().

Here is the call graph for this function:

Here is the caller graph for this function:

print()

void geom::ParticleTransform::print ( int  nt = 0, int  lvl = 0  ) const

inline

Prints the information about the object.

Parameters

nt	Number of tabs to append before printing
lvl	Information level (higher means more information)

Definition at line 126 of file particleTransform.h.

{ std::cout << printStr(nt, lvl); }

References printStr().

Here is the call graph for this function:

printStr()

std::string geom::ParticleTransform::printStr ( int  nt = 0, int  lvl = 0  ) const

inline

Returns the string containing printable information about the object.

Parameters

nt	Number of tabs to append before printing
lvl	Information level (higher means more information)

Returns

string String containing printable information about the object

Definition at line 105 of file particleTransform.h.

                                                    {
 
    auto tabS = util::io::getTabS(nt);
    std::ostringstream oss;
    oss << tabS << "------- ParticleTransform --------" << std::endl << std::endl;
    oss << tabS << "Scale = " << d_scale << std::endl;
    oss << tabS << "Angle = " << d_theta << std::endl;
    oss << tabS << "Translation = " << d_translation.printStr() << std::endl;
    oss << tabS << "Rotation pivot = " << d_rotationPoint.printStr() << std::endl;
    oss << tabS << "Axis = " << d_axis.printStr() << std::endl;
    oss << tabS << std::endl;
 
    return oss.str();
  }

References d_axis, d_rotationPoint, d_scale, d_theta, d_translation, util::io::getTabS(), and util::Point::printStr().

Referenced by print().

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

d_axis

util::Point geom::ParticleTransform::d_axis

Unit axis of rotation.

Definition at line 32 of file particleTransform.h.

Referenced by apply(), and printStr().

d_rotationPoint

util::Point geom::ParticleTransform::d_rotationPoint

Pivot \(\mathbf p\) for rotation and scale (same role as rotationPoint in GeomObject::transform). Default origin for legacy meshes centered at zero.

Definition at line 41 of file particleTransform.h.

Referenced by apply(), and printStr().

d_scale

double geom::ParticleTransform::d_scale

Uniform scale factor.

Definition at line 38 of file particleTransform.h.

Referenced by apply(), particle::BaseParticle::BaseParticle(), and printStr().

d_theta

double geom::ParticleTransform::d_theta

Angle of rotation (radians)

Definition at line 35 of file particleTransform.h.

Referenced by apply(), and printStr().

d_translation

util::Point geom::ParticleTransform::d_translation

Rigid translation \(\mathbf t\) after rotate+scale about the pivot (matches GeomObject::transform).

Definition at line 29 of file particleTransform.h.

Referenced by apply(), and printStr().

---

The documentation for this struct was generated from the following file:

• /home/user/project/src/geom/particleTransform.h