Inheritance diagram for ElasticBands::SubtractDomain:

Public Member Functions
	SubtractDomain (IDomain &primary, IDomain &subtracted)

virtual Vector	getCenter () const override
	Returns the center of the domain. More...

virtual Box	getBoundingBox () const override
	Returns the bounding box of the domain. More...

virtual Float	getVolume () const override
	Returns the total volume of the domain. More...

virtual Float	getSurfaceArea () const override
	Returns the surface area of the domain. More...

virtual bool	contains (const Vector &v) const override
	Checks if the given point lies inside the domain. More...

virtual void	getSubset (ArrayView< const Vector >, Array< Size > &, const SubsetType) const override
	Returns an array of indices, marking vectors with given property by their index. More...

virtual void	getDistanceToBoundary (ArrayView< const Vector >, Array< Float > &) const override
	Returns distances of particles lying close to the boundary. More...

virtual void	project (ArrayView< Vector >, Optional< ArrayView< Size >>) const override
	Projects vectors outside of the domain onto its boundary. More...

virtual void	addGhosts (ArrayView< const Vector >, Array< Ghost > &, const Float, const Float) const override
	Duplicates positions located close to the boundary, placing copies ("ghosts") symmetrically to the other side of the domain. More...

Public Member Functions inherited from Polymorphic
virtual	~Polymorphic ()

Detailed Description

Definition at line 43 of file ElasticBands.cpp.

Constructor & Destructor Documentation

◆ SubtractDomain()

ElasticBands::SubtractDomain::SubtractDomain	(	IDomain &	primary,
		IDomain &	subtracted
	)

inline

Definition at line 49 of file ElasticBands.cpp.

Member Function Documentation

◆ addGhosts()

virtual void ElasticBands::SubtractDomain::addGhosts	(	ArrayView< const Vector >	vs,
		Array< Ghost > &	ghosts,
		const	eta,
		const	eps
	)		const

inlineoverridevirtual

Duplicates positions located close to the boundary, placing copies ("ghosts") symmetrically to the other side of the domain.

Distance of the copy (ghost) to the boundary shall be the same as the source vector. One vector can create multiple ghosts.

Parameters

vs	Array containing vectors creating ghosts.
ghosts	Output parameter containing created ghosts, stored as pairs (position of ghost and index of source vector). Array must be cleared by the function!
eta	Dimensionless distance to the boundary necessary for creating a ghost. A ghost is created for vector v if it is closer than radius * v[H]. Vector must be inside, outside vectors are ignored.
eps	Minimal dimensionless distance of ghost from the source vector. When vector is too close to the boundary, the ghost would be too close or even on top of the source vector; implementation must place the ghost so that it is outside of the domain and at least eps * v[H] from the vector. Must be strictly lower than radius, checked by assert.

Implements IDomain.

Definition at line 85 of file ElasticBands.cpp.

◆ contains()

virtual bool ElasticBands::SubtractDomain::contains ( const Vector & v ) const

inlineoverridevirtual

Checks if the given point lies inside the domain.

Points lying exactly on the boundary of the domain are assumed to be inside.

Implements IDomain.

Definition at line 69 of file ElasticBands.cpp.

◆ getBoundingBox()

virtual Box ElasticBands::SubtractDomain::getBoundingBox ( ) const

inlineoverridevirtual

Returns the bounding box of the domain.

Implements IDomain.

Definition at line 57 of file ElasticBands.cpp.

◆ getCenter()

virtual Vector ElasticBands::SubtractDomain::getCenter ( ) const

inlineoverridevirtual

Returns the center of the domain.

Implements IDomain.

Definition at line 53 of file ElasticBands.cpp.

◆ getDistanceToBoundary()

virtual void ElasticBands::SubtractDomain::getDistanceToBoundary	(	ArrayView< const Vector >	vs,
		Array< Float > &	distances
	)		const

inlineoverridevirtual

Returns distances of particles lying close to the boundary.

The distances are signed, negative number means the particle is lying outside of the domain. Distances can be computed with small error to simplify implementation.

Parameters

vs	Input array of points.
distances	Output array, will be resized to the size of particle array and cleared.

Todo:: unify the (non)clearing of output arrays

Implements IDomain.

Definition at line 77 of file ElasticBands.cpp.

◆ getSubset()

virtual void ElasticBands::SubtractDomain::getSubset	(	ArrayView< const Vector >	vs,
		Array< Size > &	output,
		const	type
	)		const

inlineoverridevirtual

Returns an array of indices, marking vectors with given property by their index.

Parameters

vs	Input array of points.
output	Output array, is not cleared by the method, previously stored values are kept unchanged. Indices of vectors belonging in the subset are pushed into the array.
type	Type of the subset, see SubsetType.

Implements IDomain.

Definition at line 73 of file ElasticBands.cpp.

◆ getSurfaceArea()

virtual Float ElasticBands::SubtractDomain::getSurfaceArea ( ) const

inlineoverridevirtual

Returns the surface area of the domain.

Implements IDomain.

Definition at line 65 of file ElasticBands.cpp.

◆ getVolume()

virtual Float ElasticBands::SubtractDomain::getVolume ( ) const

inlineoverridevirtual

Returns the total volume of the domain.

This should be identical to computing an integral of isInside function, although faster and more precise.

Implements IDomain.

Definition at line 61 of file ElasticBands.cpp.

◆ project()

virtual void ElasticBands::SubtractDomain::project	(	ArrayView< Vector >	vs,
		Optional< ArrayView< Size >>	indices
	)		const

inlineoverridevirtual

Projects vectors outside of the domain onto its boundary.

Vectors inside the domain are untouched. Function does not affect 4th component of vectors.

Parameters

vs	Array of vectors we want to project
indices	Optional array of indices. If passed, only selected vectors will be projected. All vectors are projected by default.

Implements IDomain.

Definition at line 81 of file ElasticBands.cpp.

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

/home/pavel/projects/astro/sph/src/cli/problems/elastic_bands/ElasticBands.cpp

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ SubtractDomain()

Member Function Documentation

◆ addGhosts()

◆ contains()

◆ getBoundingBox()

◆ getCenter()

◆ getDistanceToBoundary()

◆ getSubset()

◆ getSurfaceArea()

◆ getVolume()

◆ project()