Class for a constant force source. More...

#include <TargettedTemporaryConstantForce.h>

Inheritance diagram for TargettedTemporaryConstantForce:

Collaboration diagram for TargettedTemporaryConstantForce:

Public Member Functions
	TargettedTemporaryConstantForce (const std::vector< size_t > &targetIndices, const std::array< double, 3 > &force, double start_time, double end_time)
	Construct a new Targetted Temporary Constant Force object. More...

void	applyForce (std::vector< Particle > &particle_vector, double curr_simulation_time) const override
	Applies the force directly to the particles with the specified indices within the vector. More...

	operator std::string () const override
	Conversion from a force source object to a string containing its name. More...

Public Member Functions inherited from TargettedForceSource
	TargettedForceSource (const std::vector< size_t > &target_indices)

virtual	~TargettedForceSource ()=default
	Virtual destructor for correct cleanup of derived classes. More...

Private Attributes
const std::array< double, 3 >	force
	Force exerted on the particles. More...

const double	start_time
	Start Time within the simulation from which on the force is exerted. More...

const double	end_time
	End Time within the simulation until which the force is exerted. More...

Additional Inherited Members
Protected Attributes inherited from TargettedForceSource
std::vector< size_t >	target_indices
	Indices of the particles on which the force is applied. More...

Detailed Description

Class for a constant force source.

Class for a constant force source, which exerts a constant force on the particles with the specified indices.

Definition at line 10 of file TargettedTemporaryConstantForce.h.

Constructor & Destructor Documentation

◆ TargettedTemporaryConstantForce()

TargettedTemporaryConstantForce::TargettedTemporaryConstantForce	(	const std::vector< size_t > &	targetIndices,
		const std::array< double, 3 > &	force,
		double	start_time,
		double	end_time
	)

Construct a new Targetted Temporary Constant Force object.

Parameters

targetIndices	Indices of the particles on which the force is applied
force	Force exerted on the particles
start_time	Time for which the force is exerted
end_time	Time until which the force is exerted

Definition at line 7 of file TargettedTemporaryConstantForce.cpp.

9 : TargettedForceSource(targetIndices), force(force), start_time(start_time), end_time(end_time) {}

TargettedForceSource::TargettedForceSource

TargettedForceSource(const std::vector< size_t > &target_indices)

Definition: TargettedForceSource.h:28

TargettedTemporaryConstantForce::end_time

const double end_time

End Time within the simulation until which the force is exerted.

Definition: TargettedTemporaryConstantForce.h:25

TargettedTemporaryConstantForce::force

const std::array< double, 3 > force

Force exerted on the particles.

Definition: TargettedTemporaryConstantForce.h:15

TargettedTemporaryConstantForce::start_time

const double start_time

Start Time within the simulation from which on the force is exerted.

Definition: TargettedTemporaryConstantForce.h:20

Member Function Documentation

◆ applyForce()

void TargettedTemporaryConstantForce::applyForce	(	std::vector< Particle > &	particle_vector,
		double	curr_simulation_time
	)		const

overridevirtual

Applies the force directly to the particles with the specified indices within the vector.

Parameters

particle_vector	Particle vector on which the force is applied
curr_simulation_time	Current simulation time

Calculates and applies the force exerted on the particles identified by index within the given particle vector.

Implements TargettedForceSource.

Definition at line 11 of file TargettedTemporaryConstantForce.cpp.

                                                                                                                         {
     if (curr_simulation_time < start_time || curr_simulation_time > end_time) {
         return;
     }
  
     for (auto& index : target_indices) {
         Particle& particle = particle_vector[index];
         particle.setF(particle.getF() + force);
     }
 }

◆ operator std::string()

TargettedTemporaryConstantForce::operator std::string ( ) const

explicitoverridevirtual

Conversion from a force source object to a string containing its name.

Implements TargettedForceSource.

Definition at line 22 of file TargettedTemporaryConstantForce.cpp.

                                                           {
     return fmt::format("TargettedTemporaryConstantForce (start: {}, end: {}, force: [{}, {}, {}])", start_time, end_time, force[0],
                        force[1], force[2]);
 }

Member Data Documentation

◆ end_time

const double TargettedTemporaryConstantForce::end_time

private

End Time within the simulation until which the force is exerted.

Definition at line 25 of file TargettedTemporaryConstantForce.h.

◆ force

const std::array<double, 3> TargettedTemporaryConstantForce::force

private

Force exerted on the particles.

Definition at line 15 of file TargettedTemporaryConstantForce.h.

◆ start_time

const double TargettedTemporaryConstantForce::start_time

private

Start Time within the simulation from which on the force is exerted.

Definition at line 20 of file TargettedTemporaryConstantForce.h.

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

Public Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ TargettedTemporaryConstantForce()

Member Function Documentation

◆ applyForce()

◆ operator std::string()

Member Data Documentation

◆ end_time

◆ force

◆ start_time