CGFields::LiquidMigrationFields Class Reference

Contains the computed field values, like density, momentum and stress. More...

#include <LiquidMigrationFields.h>

Inheritance diagram for CGFields::LiquidMigrationFields:

Public Member Functions
	LiquidMigrationFields ()
	Default constructor, sets all field values to zero. More...
	LiquidMigrationFields (const LiquidMigrationFields &P)=default
	Default copy constructor, copies the values of all fields. More...
	~LiquidMigrationFields ()=default
	Destructor, it simply destructs the LiquidMigrationFields 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...
LiquidMigrationFields	getSquared () const
	Returns the square of all field values (to calculate standard deviation). More...
LiquidMigrationFields &	operator= (const LiquidMigrationFields &P)
	Copies all field values. More...
LiquidMigrationFields &	operator+= (const LiquidMigrationFields &P)
	Adds the field values on the RHS to the LHS of the equation. More...
LiquidMigrationFields &	operator-= (const LiquidMigrationFields &P)
	Subtracts the field values on the RHS from the LHS of the equation. More...
LiquidMigrationFields &	operator/= (Mdouble a)
	Divides the field values on the LHS by the RHS of the equation. More...
LiquidMigrationFields	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 LiquidMigrationFields &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 LiquidMigrationFields &currentInteraction)
void	addInteractionStatistics (Mdouble psi, const LiquidMigrationFields &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 LiquidMigrationFields &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	getLiquidBridgeVolume () const
Mdouble	getLiquidFilmVolume () 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	liquidBridgeVolume_
Mdouble	liquidFilmVolume_

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...

Detailed Description

Contains the computed field values, like density, momentum and stress.

CGPoints inherits from this class; CGPoints::evaluate adds to the values of these variables.

Todo:

These are currently the only fields that are computed. However, this class is destined to be extended to contain additional information such as fabric, energy, local angular momentum. Also, a simpler version is planned, where only particle statistics are evaluated (density and momentum).

Constructor & Destructor Documentation

LiquidMigrationFields() [1/2]

CGFields::LiquidMigrationFields::LiquidMigrationFields

(

)

Default constructor, sets all field values to zero.

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

References setZero().

LiquidMigrationFields() [2/2]

CGFields::LiquidMigrationFields::LiquidMigrationFields ( const LiquidMigrationFields &  P )

default

Default copy constructor, copies the values of all fields.

~LiquidMigrationFields()

CGFields::LiquidMigrationFields::~LiquidMigrationFields ( )

default

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

Member Function Documentation

addContactPointStatistics()

void CGFields::LiquidMigrationFields::addContactPointStatistics	(	Mdouble phi	,
		const LiquidMigrationFields &	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

{
}

addInteractionStatistics()

void CGFields::LiquidMigrationFields::addInteractionStatistics	(	Mdouble	psi,
		const LiquidMigrationFields &	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

{
    liquidBridgeVolume_ += currentInteraction.getLiquidBridgeVolume() * psi;
}

References getLiquidBridgeVolume(), and liquidBridgeVolume_.

addParticleDifferentialStatistics()

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

{
}

addParticleStatistics()

void CGFields::LiquidMigrationFields::addParticleStatistics	(	Mdouble	phi,
		const LiquidMigrationFields &	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

{
    liquidFilmVolume_ += currentInteraction.getLiquidFilmVolume() * phi;
}

References getLiquidFilmVolume(), and liquidFilmVolume_.

doInteractionStatistics()

bool CGFields::LiquidMigrationFields::doInteractionStatistics ( )

static

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

{
    return true;
}

evaluateFixedParticles()

static bool CGFields::LiquidMigrationFields::evaluateFixedParticles ( )

inlinestatic

    {
        return true;
    }

getLiquidBridgeVolume()

Mdouble CGFields::LiquidMigrationFields::getLiquidBridgeVolume ( ) const

inline

    {
        return liquidBridgeVolume_;
    }

References liquidBridgeVolume_.

Referenced by addInteractionStatistics().

getLiquidFilmVolume()

Mdouble CGFields::LiquidMigrationFields::getLiquidFilmVolume ( ) const

inline

    {
        return liquidFilmVolume_;
    }

References liquidFilmVolume_.

Referenced by addParticleStatistics().

getSquared()

LiquidMigrationFields CGFields::LiquidMigrationFields::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

{
    LiquidMigrationFields P;
    P.liquidBridgeVolume_ = mathsFunc::square(liquidBridgeVolume_);
    P.liquidFilmVolume_ = mathsFunc::square(liquidFilmVolume_);
    return P;
}

References liquidBridgeVolume_, liquidFilmVolume_, Global_Physical_Variables::P, and mathsFunc::square().

isDifferentialField()

static bool CGFields::LiquidMigrationFields::isDifferentialField ( )

inlinestatic

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

    {
        return false;
    }

operator*()

LiquidMigrationFields CGFields::LiquidMigrationFields::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

{
    LiquidMigrationFields p;
    p.liquidBridgeVolume_ = liquidBridgeVolume_ * a;
    p.liquidFilmVolume_ = liquidFilmVolume_ * a;
    return p;
}

References a, liquidBridgeVolume_, liquidFilmVolume_, and p.

operator+=()

LiquidMigrationFields & CGFields::LiquidMigrationFields::operator+=

(

const LiquidMigrationFields &

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

{
    liquidBridgeVolume_ += P.liquidBridgeVolume_;
    liquidFilmVolume_ += P.liquidFilmVolume_;
    return *this;
}

References liquidBridgeVolume_, liquidFilmVolume_, and Global_Physical_Variables::P.

operator-=()

LiquidMigrationFields & CGFields::LiquidMigrationFields::operator-=

(

const LiquidMigrationFields &

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

{
    liquidBridgeVolume_ -= P.liquidBridgeVolume_;
    liquidFilmVolume_ -= P.liquidFilmVolume_;
    return *this;
}

References liquidBridgeVolume_, liquidFilmVolume_, and Global_Physical_Variables::P.

operator/=()

LiquidMigrationFields & CGFields::LiquidMigrationFields::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

{
    liquidBridgeVolume_ /= a;
    liquidFilmVolume_ /= a;
    return *this;
}

References a, liquidBridgeVolume_, and liquidFilmVolume_.

operator=()

LiquidMigrationFields & CGFields::LiquidMigrationFields::operator= ( const LiquidMigrationFields &  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::LiquidMigrationFields::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 << "liquidBridgeVolume " << liquidBridgeVolume_;
    os << " liquidFilmVolume " << liquidFilmVolume_;
}

References liquidBridgeVolume_, and liquidFilmVolume_.

setCylindricalFields() [1/2]

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

{
    setFields(c, type);
}

References calibrate::c, setFields(), and compute_granudrum_aor::type.

setCylindricalFields() [2/2]

void CGFields::LiquidMigrationFields::setCylindricalFields

(

const BaseParticle &

p

)

{
    setFields(p);
}

References p, and setFields().

setFields() [1/2]

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

{
    auto l = dynamic_cast<const LiquidMigrationWilletInteraction*>(&c);
    logger.assert_debug(l != nullptr,
                  "LiquidMigrationFields::addParticleStatistics: "
                  "interaction type should be LiquidMigrationWilletInteraction");
    liquidBridgeVolume_ = l->getLiquidBridgeVolume();
}

References calibrate::c, liquidBridgeVolume_, and logger.

Referenced by setCylindricalFields().

setFields() [2/2]

void CGFields::LiquidMigrationFields::setFields

(

const BaseParticle &

p

)

{
    auto l = dynamic_cast<const LiquidFilmParticle*>(&p);
    logger.assert_debug(l != nullptr,
                  "LiquidMigrationFields::addParticleStatistics: particle type should be LiquidFilmParticle");
    liquidFilmVolume_ = l->getLiquidVolume();
}

References liquidFilmVolume_, logger, and p.

setZero()

void CGFields::LiquidMigrationFields::setZero

(

)

Sets all fields to zero.

{
    liquidBridgeVolume_ = 0.0;
    liquidFilmVolume_ = 0.0;
}

References liquidBridgeVolume_, and liquidFilmVolume_.

Referenced by LiquidMigrationFields().

write()

void CGFields::LiquidMigrationFields::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 << liquidBridgeVolume_;
    os << " " << liquidFilmVolume_;
}

References liquidBridgeVolume_, and liquidFilmVolume_.

writeNames()

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

static

Parameters

[out]

os

the ostream into which the data is written.

{
    os << countVariables + 1 << ":liquidBridgeVolume ";
    os << countVariables + 2 << ":liquidFilmVolume ";
}

Member Data Documentation

liquidBridgeVolume_

Mdouble CGFields::LiquidMigrationFields::liquidBridgeVolume_

private

liquid bridge volume density, computed as the sum over all particles i

\[ V_lb(\vec r,t) = \sum_i V_i \phi(\vec r,\vec r_i), \]

with liquid bridge volume V_i and cg function \(\phi(\vec r,\vec r_i)\), see CGFunctions::Gauss::evaluateCGFunction.

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

liquidFilmVolume_

Mdouble CGFields::LiquidMigrationFields::liquidFilmVolume_

private

liquid bridge volume density, computed as the sum over all particles i

\[ V_lb(\vec r,t) = \sum_i V_i \phi(\vec r,\vec r_i), \]

with liquid bridge volume V_i and cg function \(\phi(\vec r,\vec r_i)\), see CGFunctions::Gauss::evaluateCGFunction.

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

---

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

• LiquidMigrationFields.h
• LiquidMigrationFields.cc