#include <GradVelocityField.h>

Inheritance diagram for CGFields::GradVelocityField:

Public Member Functions
	GradVelocityField ()
	Default constructor, sets all field values to zero. More...

	GradVelocityField (const GradVelocityField &P)=default
	Default copy constructor, copies the values of all fields. More...

	~GradVelocityField ()=default
	Destructor, it simply destructs the GradVelocityField and all the objects it contains. More...

void	write (std::ostream &os) const
	Writes class content into an output stream, typically a stat file. More...

void	output (std::ostream &os) const
	Writes human-readable class content into an output stream, typically a stat file. More...

void	setZero ()
	Sets all fields to zero. More...

GradVelocityField	getSquared () const
	Returns the square of all field values (to calculate standard deviation). More...

GradVelocityField &	operator= (const GradVelocityField &P)
	Copies all field values. More...

GradVelocityField &	operator+= (const GradVelocityField &P)
	Adds the field values on the RHS to the LHS of the equation. More...

GradVelocityField &	operator-= (const GradVelocityField &P)
	Subtracts the field values on the RHS from the LHS of the equation. More...

GradVelocityField &	operator/= (Mdouble a)
	Divides the field values on the LHS by the RHS of the equation. More...

GradVelocityField	operator* (Mdouble a) const
	Multiplies the field values on the left of the '' by the scalar value on the right of the '' and returns the answer. More...

void	addParticleStatistics (Mdouble phi, const GradVelocityField &currentInteraction)
	This function should be called from within a loop over all particles to compute all the fields that are defined as a sum over all particles (e.g. density, momentum). More...

void	addParticleDifferentialStatistics (Vec3D &dphi, const GradVelocityField &currentInteraction)

void	addInteractionStatistics (Mdouble psi, const GradVelocityField &currentInteraction)
	This function should be called from within a loop over all Interactions to compute all the fields that are defined as a sum over all Interactions (e.g. stress). More...

void	addContactPointStatistics (Mdouble phi, const GradVelocityField &currentInteraction)
	This function should be called from within a loop over all Interactions to compute all the fields that are defined as a sum over all Interactions with external objects (e.g. IFD). More...

void	setFields (const BaseInteraction &c, IntegralType type)

void	setCylindricalFields (const BaseInteraction &c, IntegralType type)

void	setFields (const BaseParticle &p)

void	setCylindricalFields (const BaseParticle &p)

Mdouble	getDensity () const

Vec3D	getMomentum () const

Vec3D	getDDensity () const

Matrix3D	getDMomentum () const

Public Member Functions inherited from CGFields::BaseFields
void	setCG (BaseCG *cg)

BaseCG *	getCG ()

Static Public Member Functions
static void	writeNames (std::ostream &os, unsigned countVariables)

static bool	doInteractionStatistics ()
	Returns true if the class contains fields that are defined as a sum over all Interactions (e.g. stress), else returns false. More...

static bool	evaluateFixedParticles ()

static bool	isDifferentialField ()

Private Attributes
Mdouble	density_

Vec3D	momentum_

Vec3D	ddensity_

Matrix3D	dmomentum_

Additional Inherited Members
Protected Attributes inherited from CGFields::BaseFields
BaseCG *	cg_ = nullptr
	Stores a pointer to the baseCG instance to get e.g. the handler and time information. More...

Constructor & Destructor Documentation

◆ GradVelocityField() [1/2]

CGFields::GradVelocityField::GradVelocityField ( )

Default constructor, sets all field values to zero.

 {
     setZero();
 #ifdef DEBUG_CONSTRUCTOR
     std::cerr << "GradVelocityField::GradVelocityField() finished" << std::endl;
 #endif
 }

References setZero().

◆ GradVelocityField() [2/2]

CGFields::GradVelocityField::GradVelocityField ( const GradVelocityField & P )

default

Default copy constructor, copies the values of all fields.

◆ ~GradVelocityField()

CGFields::GradVelocityField::~GradVelocityField ( )

default

Destructor, it simply destructs the GradVelocityField and all the objects it contains.

Member Function Documentation

◆ addContactPointStatistics()

void CGFields::GradVelocityField::addContactPointStatistics	(	Mdouble	phi,
		const GradVelocityField &	currentInteraction
	)

This function should be called from within a loop over all Interactions to compute all the fields that are defined as a sum over all Interactions with external objects (e.g. IFD).

Parameters

[in]	phi	the value of the cg function for the contact point of c and the current CGPoint
[in]	c	the interaction which is used in the cg function

157 {

158 }

◆ addInteractionStatistics()

void CGFields::GradVelocityField::addInteractionStatistics	(	Mdouble	psi,
		const GradVelocityField &	currentInteraction
	)

This function should be called from within a loop over all Interactions to compute all the fields that are defined as a sum over all Interactions (e.g. stress).

Parameters

[in]	psi	the value of the line integral from C to P at the current CGPoint
[in]	c	the contact which is used in the line integral

148 {

149 }

◆ addParticleDifferentialStatistics()

void CGFields::GradVelocityField::addParticleDifferentialStatistics	(	Vec3D &	dphi,
		const GradVelocityField &	currentInteraction
	)

 {
     ddensity_ += currentInteraction.getDensity() * dphi;
     dmomentum_ += Matrix3D::dyadic(currentInteraction.getMomentum(), dphi);
 }

References ddensity_, dmomentum_, Matrix3D::dyadic(), getDensity(), and getMomentum().

◆ addParticleStatistics()

void CGFields::GradVelocityField::addParticleStatistics	(	Mdouble	phi,
		const GradVelocityField &	currentInteraction
	)

This function should be called from within a loop over all particles to compute all the fields that are defined as a sum over all particles (e.g. density, momentum).

Parameters

[in]	phi	the value of the cg function at the current CGPoint
[in]	p	the particle which is used in the cg function

 {
     density_ += currentInteraction.getDensity() * phi;
     momentum_ += currentInteraction.getMomentum() * phi;
 }

References density_, getDensity(), getMomentum(), and momentum_.

◆ doInteractionStatistics()

bool CGFields::GradVelocityField::doInteractionStatistics ( )

static

Returns true if the class contains fields that are defined as a sum over all Interactions (e.g. stress), else returns false.

If the functions returns false, addInteractionStatistics and addContactPointStatistics are never called.

Returns: True if the class contains fields that are defined as a sum over all Interactions, else false.

 {
     return false;
 }

◆ evaluateFixedParticles()

static bool CGFields::GradVelocityField::evaluateFixedParticles ( )

inlinestatic

     {
         return false;
     }

◆ getDDensity()

Vec3D CGFields::GradVelocityField::getDDensity ( ) const

inline

     {
         return ddensity_;
     }

References ddensity_.

◆ getDensity()

Mdouble CGFields::GradVelocityField::getDensity ( ) const

inline

     {
         return density_;
     }

References density_.

Referenced by addParticleDifferentialStatistics(), and addParticleStatistics().

◆ getDMomentum()

Matrix3D CGFields::GradVelocityField::getDMomentum ( ) const

inline

     {
         return dmomentum_;
     }

References dmomentum_.

◆ getMomentum()

Vec3D CGFields::GradVelocityField::getMomentum ( ) const

inline

     {
         return momentum_;
     }

References momentum_.

Referenced by addParticleDifferentialStatistics(), and addParticleStatistics().

◆ getSquared()

GradVelocityField CGFields::GradVelocityField::getSquared ( ) const

Returns the square of all field values (to calculate standard deviation).

Returns: a CGField containing the square of the values in the current object

 {
     GradVelocityField P;
     P.density_ = mathsFunc::square(density_);
     P.momentum_ = Vec3D::square(momentum_);
     P.ddensity_ = Vec3D::square(ddensity_);
     P.dmomentum_ = Matrix3D::square(dmomentum_);
     return P;
 }

References ddensity_, density_, dmomentum_, momentum_, Global_Physical_Variables::P, Matrix3D::square(), mathsFunc::square(), and Vec3D::square().

◆ isDifferentialField()

static bool CGFields::GradVelocityField::isDifferentialField ( )

inlinestatic

A bool that determines if the derivative of the CG function has to be computed

     {
         return true;
     }

◆ operator*()

GradVelocityField CGFields::GradVelocityField::operator* ( Mdouble a ) const

Multiplies the field values on the left of the '*' by the scalar value on the right of the '*' and returns the answer.

Parameters

[in] a the scalar that we multiply with

Returns: the CGField to which the multiplied values are written

 {
     GradVelocityField p;
     p.density_ = density_ * a;
     p.momentum_ = momentum_ * a;
     p.ddensity_ = ddensity_ * a;
     p.dmomentum_ = dmomentum_ * a;
     return p;
 }

References a, ddensity_, density_, dmomentum_, momentum_, and p.

◆ operator+=()

GradVelocityField & CGFields::GradVelocityField::operator+= ( const GradVelocityField & P )

Adds the field values on the RHS to the LHS of the equation.

Parameters

[in] P the CGField that has to be added

Returns: the CGField to which the values are added

 {
     density_ += P.density_;
     momentum_ += P.momentum_;
     ddensity_ += P.ddensity_;
     dmomentum_ += P.dmomentum_;
     return *this;
 }

References ddensity_, density_, dmomentum_, momentum_, and Global_Physical_Variables::P.

◆ operator-=()

GradVelocityField & CGFields::GradVelocityField::operator-= ( const GradVelocityField & P )

Subtracts the field values on the RHS from the LHS of the equation.

Parameters

[in] P the CGField that has to be subtracted

Returns: the CGField from which the values are subtracted

 {
     density_ -= P.density_;
     momentum_ -= P.momentum_;
     ddensity_ -= P.ddensity_;
     dmomentum_ -= P.dmomentum_;
     return *this;
 }

References ddensity_, density_, dmomentum_, momentum_, and Global_Physical_Variables::P.

◆ operator/=()

GradVelocityField & CGFields::GradVelocityField::operator/= ( Mdouble a )

Divides the field values on the LHS by the RHS of the equation.

Parameters

[in] a the scalar that we divide by

Returns: the CGField to which the divided values are written

 {
     density_ /= a;
     momentum_ /= a;
     ddensity_ /= a;
     dmomentum_ /= a;
     return *this;
 }

References a, ddensity_, density_, dmomentum_, and momentum_.

◆ operator=()

GradVelocityField & CGFields::GradVelocityField::operator= ( const GradVelocityField & P )

default

Copies all field values.

Parameters

[in] P the CGField that has to be copied

Returns: the CGField into which the values are copied

◆ output()

void CGFields::GradVelocityField::output ( std::ostream & os ) const

Writes human-readable class content into an output stream, typically a stat file.

Parameters

[out] os the ostream into which the data is written.

 {
     os << "density " << density_;
     os << " momentum " << momentum_;
     os << " ddensity " << ddensity_;
     os << " dmomentum " << dmomentum_;
 }

References ddensity_, density_, dmomentum_, and momentum_.

◆ setCylindricalFields() [1/2]

void CGFields::GradVelocityField::setCylindricalFields	(	const BaseInteraction &	c,
		IntegralType	type
	)

188 {

189 }

◆ setCylindricalFields() [2/2]

void CGFields::GradVelocityField::setCylindricalFields ( const BaseParticle & p )

 {
     setFields(p);
     momentum_ = momentum_.getCylindricalTensorField(p.getPosition());
 }

References Vec3D::getCylindricalTensorField(), momentum_, p, and setFields().

◆ setFields() [1/2]

void CGFields::GradVelocityField::setFields	(	const BaseInteraction &	c,
		IntegralType	type
	)

178 {

179 }

Referenced by setCylindricalFields().

◆ setFields() [2/2]

void CGFields::GradVelocityField::setFields ( const BaseParticle & p )

 {
     density_ = p.getMass();
     momentum_ = p.getVelocity() * p.getMass();
 }

References density_, momentum_, and p.

◆ setZero()

void CGFields::GradVelocityField::setZero ( )

Sets all fields to zero.

 {
     density_ = 0.0;
     momentum_.setZero();
     ddensity_.setZero();
     dmomentum_.setZero();
 }

References ddensity_, density_, dmomentum_, momentum_, Matrix3D::setZero(), and Vec3D::setZero().

Referenced by GradVelocityField().

◆ write()

void CGFields::GradVelocityField::write ( std::ostream & os ) const

Writes class content into an output stream, typically a stat file.

Parameters

[out] os the ostream into which the data is written.

 {
     os << density_;
     os << " " << momentum_;
     os << " " << ddensity_;
     os << " " << dmomentum_;
 }

References ddensity_, density_, dmomentum_, and momentum_.

◆ writeNames()

void CGFields::GradVelocityField::writeNames	(	std::ostream &	os,
		unsigned	countVariables
	)

static

Parameters

[out] os the ostream into which the data is written.

 {
     os << countVariables + 1 << ":Density ";
     os << countVariables + 2 << "-" << countVariables + 4 << ":momentum ";
     os << countVariables + 5 << "-" << countVariables + 7 << ":ddensity ";
     os << countVariables + 8 << "-" << countVariables + 16 << ":dmomentum ";
 }

Member Data Documentation

◆ ddensity_

Vec3D CGFields::GradVelocityField::ddensity_

private

Referenced by addParticleDifferentialStatistics(), getDDensity(), getSquared(), operator*(), operator+=(), operator-=(), operator/=(), output(), setZero(), and write().

◆ density_

Mdouble CGFields::GradVelocityField::density_

private

Referenced by addParticleStatistics(), getDensity(), getSquared(), operator*(), operator+=(), operator-=(), operator/=(), output(), setFields(), setZero(), and write().

◆ dmomentum_

Matrix3D CGFields::GradVelocityField::dmomentum_

private

Referenced by addParticleDifferentialStatistics(), getDMomentum(), getSquared(), operator*(), operator+=(), operator-=(), operator/=(), output(), setZero(), and write().

◆ momentum_

Vec3D CGFields::GradVelocityField::momentum_

private

Referenced by addParticleStatistics(), getMomentum(), getSquared(), operator*(), operator+=(), operator-=(), operator/=(), output(), setCylindricalFields(), setFields(), setZero(), and write().

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

Public Member Functions

Static Public Member Functions

Private Attributes

Additional Inherited Members

Constructor & Destructor Documentation

◆ GradVelocityField() [1/2]

◆ GradVelocityField() [2/2]

◆ ~GradVelocityField()

Member Function Documentation

◆ addContactPointStatistics()

◆ addInteractionStatistics()

◆ addParticleDifferentialStatistics()

◆ addParticleStatistics()

◆ doInteractionStatistics()

◆ evaluateFixedParticles()

◆ getDDensity()

◆ getDensity()

◆ getDMomentum()

◆ getMomentum()

◆ getSquared()

◆ isDifferentialField()

◆ operator*()

◆ operator+=()

◆ operator-=()

◆ operator/=()

◆ operator=()

◆ output()

◆ setCylindricalFields() [1/2]

◆ setCylindricalFields() [2/2]

◆ setFields() [1/2]

◆ setFields() [2/2]

◆ setZero()

◆ write()

◆ writeNames()

Member Data Documentation

◆ ddensity_

◆ density_

◆ dmomentum_

◆ momentum_