pbat::gpu::vbd::Integrator Class Reference

The VBD public API wrapper around the VBD integrator implementation. [2]. More...

#include <Integrator.h>

Public Types
using	EInitializationStrategy
	Initialization strategy.
using	Data = pbat::sim::vbd::Data
	VBD data.

Public Member Functions
PBAT_API	Integrator (Data const &data)
	Construct a new Integrator object.
	Integrator (Integrator const &)=delete
Integrator &	operator= (Integrator const &)=delete
PBAT_API	Integrator (Integrator &&other) noexcept
	Move constructor.
PBAT_API Integrator &	operator= (Integrator &&other) noexcept
	Move assignment operator.
PBAT_API	~Integrator ()
	Destructor.
PBAT_API void	Step (GpuScalar dt, GpuIndex iterations, GpuIndex substeps=GpuIndex{1})
	Execute one simulation step.
PBAT_API void	TracedStep (GpuScalar dt, GpuIndex iterations, GpuIndex substeps, GpuIndex t, std::string_view dir=".")
	Execute one simulation step and trace the result.
PBAT_API void	SetPositions (Eigen::Ref< GpuMatrixX const > const &X)
	Set the vertex positions.
PBAT_API void	SetVelocities (Eigen::Ref< GpuMatrixX const > const &v)
	Set the vertex velocities.
PBAT_API void	SetExternalAcceleration (Eigen::Ref< GpuMatrixX const > const &aext)
	Set the external accelerations.
PBAT_API void	SetNumericalZeroForHessianDeterminant (GpuScalar zero)
	Set threshold for zero determinant check.
PBAT_API void	SetRayleighDampingCoefficient (GpuScalar kD)
	Set the damping coefficient for Rayleigh damping.
PBAT_API void	SetInitializationStrategy (EInitializationStrategy strategy)
	Sets the initialization strategy to kick-start the time step minimization.
PBAT_API void	SetBlockSize (GpuIndex blockSize)
	Sets the GPU thread block size, for the BDF1 minimization.
PBAT_API void	SetSceneBoundingBox (Eigen::Vector< GpuScalar, 3 > const &min, Eigen::Vector< GpuScalar, 3 > const &max)
	Sets the scene bounding box.
PBAT_API GpuMatrixX	GetPositions () const
	Get the vertex positions.
PBAT_API GpuMatrixX	GetVelocities () const
	Get the vertex velocities.

Detailed Description

The VBD public API wrapper around the VBD integrator implementation. [2].

Member Typedef Documentation

EInitializationStrategy

using pbat::gpu::vbd::Integrator::EInitializationStrategy

Initial value:

 
        pbat::sim::vbd::EInitializationStrategy

Initialization strategy.

Constructor & Destructor Documentation

Integrator() [1/2]

pbat::gpu::vbd::Integrator::Integrator

(

Data const &

data

)

Construct a new Integrator object.

Parameters

data

VBD data

Integrator() [2/2]

pbat::gpu::vbd::Integrator::Integrator ( Integrator && other )

noexcept

Move constructor.

Parameters

other

Other object

Member Function Documentation

GetPositions()

GpuMatrixX pbat::gpu::vbd::Integrator::GetPositions

(

)

const

Get the vertex positions.

Returns

|# dims|x|# vertices| array of vertex positions

GetVelocities()

GpuMatrixX pbat::gpu::vbd::Integrator::GetVelocities

(

)

const

Get the vertex velocities.

Returns

|# dims|x|# vertices| array of vertex velocities

operator=()

Integrator & pbat::gpu::vbd::Integrator::operator= ( Integrator && other )

noexcept

Move assignment operator.

Parameters

other

Other object

Returns

Reference to this object

SetBlockSize()

void pbat::gpu::vbd::Integrator::SetBlockSize

(

GpuIndex

blockSize

)

Sets the GPU thread block size, for the BDF1 minimization.

Parameters

blockSize

# threads per block, should be a multiple of 32

SetExternalAcceleration()

void pbat::gpu::vbd::Integrator::SetExternalAcceleration

(

Eigen::Ref< GpuMatrixX const > const &

aext

)

Set the external accelerations.

Parameters

aext	3x|# vertices| array of external accelerations

SetInitializationStrategy()

void pbat::gpu::vbd::Integrator::SetInitializationStrategy

(

EInitializationStrategy

strategy

)

Sets the initialization strategy to kick-start the time step minimization.

Parameters

strategy

Initialization strategy

SetNumericalZeroForHessianDeterminant()

void pbat::gpu::vbd::Integrator::SetNumericalZeroForHessianDeterminant

(

GpuScalar

zero

)

Set threshold for zero determinant check.

Parameters

zero	Numerical zero used in Hessian determinant check for approximate singularity detection

SetPositions()

void pbat::gpu::vbd::Integrator::SetPositions

(

Eigen::Ref< GpuMatrixX const > const &

X

)

Set the vertex positions.

Parameters

X	3x|# vertices| array of vertex positions

SetRayleighDampingCoefficient()

void pbat::gpu::vbd::Integrator::SetRayleighDampingCoefficient

(

GpuScalar

kD

)

Set the damping coefficient for Rayleigh damping.

Parameters

kD	Damping coefficient

SetSceneBoundingBox()

void pbat::gpu::vbd::Integrator::SetSceneBoundingBox	(	Eigen::Vector< GpuScalar, 3 > const &	min,
		Eigen::Vector< GpuScalar, 3 > const &	max )

Sets the scene bounding box.

Parameters

min	Minimum corner of the bounding box
max	Maximum corner of the bounding box

SetVelocities()

void pbat::gpu::vbd::Integrator::SetVelocities

(

Eigen::Ref< GpuMatrixX const > const &

v

)

Set the vertex velocities.

Parameters

v	3x|# vertices| array of vertex velocities

Step()

void pbat::gpu::vbd::Integrator::Step	(	GpuScalar	dt,
		GpuIndex	iterations,
		GpuIndex	substeps = GpuIndex{1} )

Execute one simulation step.

Parameters

dt	Time step
iterations	Number of optimization iterations per substep
substeps	Number of substeps

TracedStep()

void pbat::gpu::vbd::Integrator::TracedStep	(	GpuScalar	dt,
		GpuIndex	iterations,
		GpuIndex	substeps,
		GpuIndex	t,
		std::string_view	dir = "." )

Execute one simulation step and trace the result.

• Saves matrix market files which follow the pattern {variable}.t.{timestep}.s.{substep}[.k.{iteration}].mtx

Parameters

dt	Time step
iterations	Number of optimization iterations per substep
substeps	Number of substeps
t	Current time step
dir	Directory to save the matrix market files

---

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

• C:/git/PhysicsBasedAnimationToolkit/source/pbat/gpu/vbd/Integrator.h
• C:/git/PhysicsBasedAnimationToolkit/source/pbat/gpu/vbd/Integrator.cu