LiquidFilm< Particle > Class Template Reference

#include <LiquidFilmParticle.h>

Inheritance diagram for LiquidFilm< Particle >:

Public Member Functions
	LiquidFilm ()
	Basic Particle constructor, creates an Particle at (0,0,0) with radius, mass and inertia equal to 1. More...
	LiquidFilm (const LiquidFilm &p)
	Particle copy constructor, which accepts as input a reference to a Particle. It creates a copy of this Particle and all it's information. Usually it is better to use the copy() function for polymorfism. More...
	~LiquidFilm () override=default
	Particle destructor, needs to be implemented and checked if it removes tangential spring information. More...
LiquidFilm *	copy () const override
	Particle copy method. It calls to copy constructor of this Particle, useful for polymorfism. More...
void	write (std::ostream &os) const override
std::string	getName () const override
void	read (std::istream &is) override
Mdouble	getLiquidVolume () const
void	setLiquidVolume (Mdouble liquidVolume)
void	addLiquidVolume (Mdouble liquidVolume)
unsigned	getNumberOfFieldsVTK () const override
std::string	getTypeVTK (unsigned i) const override
std::string	getNameVTK (unsigned i) const override
std::vector< Mdouble >	getFieldVTK (unsigned i) const override
bool	isSphericalParticle () const override

Protected Attributes
Mdouble	liquidVolume_

Constructor & Destructor Documentation

LiquidFilm() [1/2]

template<class Particle >

LiquidFilm< Particle >::LiquidFilm ( )

inline

Basic Particle constructor, creates an Particle at (0,0,0) with radius, mass and inertia equal to 1.

default constructor

    {
        liquidVolume_ = 0;
    }

References LiquidFilm< Particle >::liquidVolume_.

Referenced by LiquidFilm< Particle >::copy().

LiquidFilm() [2/2]

template<class Particle >

LiquidFilm< Particle >::LiquidFilm ( const LiquidFilm< Particle > &  p )

inline

Particle copy constructor, which accepts as input a reference to a Particle. It creates a copy of this Particle and all it's information. Usually it is better to use the copy() function for polymorfism.

Constructor that copies most of the properties of the given particle. Please note that not everything is copied, for example the position in the HGrid is not determined yet by the end of this constructor. It also does not copy the interactions and the pointer to the handler that handles this particle. Use with care.

Parameters

[in,out]

p

Reference to the LiquidFilm this one should become a copy of.

                                    : Particle(p)
    {
        liquidVolume_ = p.liquidVolume_;
    }

References LiquidFilm< Particle >::liquidVolume_.

~LiquidFilm()

template<class Particle >

LiquidFilm< Particle >::~LiquidFilm ( )

overridedefault

Particle destructor, needs to be implemented and checked if it removes tangential spring information.

Destructor. It asks the ParticleHandler to check if this was the smallest or largest particle and adjust itself accordingly.

Member Function Documentation

addLiquidVolume()

template<class Particle >

void LiquidFilm< Particle >::addLiquidVolume ( Mdouble  liquidVolume )

inline

    {
        liquidVolume_ += liquidVolume;
    }

References LiquidFilm< Particle >::liquidVolume_.

Referenced by RotatingDrumWet::actionsAfterTimeStep(), DropletBoundary::checkBoundaryAfterParticlesMove(), LiquidMigrationLSInteraction::form(), LiquidMigrationWilletInteraction::form(), LiquidMigrationLSInteraction::rupture(), and LiquidMigrationWilletInteraction::rupture().

copy()

template<class Particle >

LiquidFilm* LiquidFilm< Particle >::copy ( ) const

inlineoverride

Particle copy method. It calls to copy constructor of this Particle, useful for polymorfism.

Copy method. Uses copy constructor to create a copy on the heap. Useful for polymorphism.

Returns

pointer to the particle's copy

    {
        return new LiquidFilm(*this);
    }

References LiquidFilm< Particle >::LiquidFilm().

getFieldVTK()

template<class Particle >

std::vector< Mdouble > LiquidFilm< Particle >::getFieldVTK ( unsigned  i ) const

override

{
    if (i==1) {
        return std::vector<Mdouble>(1, liquidVolume_);
    } else /*i=2 or 0*/ {
        Mdouble fullLiquidVolume = (i==2)?0:liquidVolume_;
        for (auto k : this->getInteractions()) {
            if(dynamic_cast<LiquidMigrationWilletInteraction*>(k)){
                auto j = dynamic_cast<LiquidMigrationWilletInteraction*>(k);
                if (j && j->getLiquidBridgeVolume()) {
                    fullLiquidVolume += 0.5*j->getLiquidBridgeVolume();
                }
            }
            if(dynamic_cast<LiquidMigrationLSInteraction*>(k)) {
                auto j = dynamic_cast<LiquidMigrationLSInteraction*>(k);
                if (j && j->getLiquidBridgeVolume()) {
                    fullLiquidVolume += 0.5 * j->getLiquidBridgeVolume();
                }
            }
 
        }
        return std::vector<Mdouble>(1, fullLiquidVolume);
    }
}

References constants::i.

getLiquidVolume()

template<class Particle >

Mdouble LiquidFilm< Particle >::getLiquidVolume ( ) const

inline

    {
        return liquidVolume_;
    }

References LiquidFilm< Particle >::liquidVolume_.

Referenced by LiquidMigrationLSInteraction::form(), LiquidMigrationWilletInteraction::form(), LiquidMigrationMPI2Test::outputXBallsData(), LiquidMigrationSelfTest::outputXBallsData(), LiquidMigrationSelfTest::printTime(), LiquidMigrationLSInteraction::rupture(), and LiquidMigrationWilletInteraction::rupture().

getName()

template<class Particle >

std::string LiquidFilm< Particle >::getName ( ) const

inlineoverride

Returns the name of the object; in this case 'LiquidFilm'.

Returns

The object name.

    {
        return "LiquidFilm";
    }

getNameVTK()

template<class Particle >

std::string LiquidFilm< Particle >::getNameVTK ( unsigned  i ) const

override

{
    if (i==1)
        return "liquidFilmVolume";
    else if (i==2)
        return "liquidBridgeVolume";
    else /*i=0*/
        return "fullLiquidVolume";
}

References constants::i.

getNumberOfFieldsVTK()

template<class Particle >

unsigned LiquidFilm< Particle >::getNumberOfFieldsVTK ( ) const

inlineoverride

    {
        return 3;
    }

getTypeVTK()

template<class Particle >

std::string LiquidFilm< Particle >::getTypeVTK ( unsigned  i ) const

inlineoverride

    {
        return "Float32";
    }

isSphericalParticle()

template<class Particle >

bool LiquidFilm< Particle >::isSphericalParticle ( ) const

inlineoverride

{return true;}

read()

template<class Particle >

void LiquidFilm< Particle >::read ( std::istream &  is )

override

Particle read function. Has an std::istream as argument, from which it extracts the radius_, invMass_ and invInertia_, respectively. From these the mass_ and inertia_ are deduced. An additional set of properties is read through the call to the parent's method BaseParticle::read().

Parameters

[in,out]

is

input stream with particle properties.

{
    Particle::read(is);
    std::string dummy;
    is >> dummy >> liquidVolume_;
    // a fix to allow reading of restart files pre-nonspherical
    if (dummy == "invInertia")
    {
        is >> dummy >> liquidVolume_;
    }
}

setLiquidVolume()

template<class Particle >

void LiquidFilm< Particle >::setLiquidVolume ( Mdouble  liquidVolume )

inline

    {
        liquidVolume_ = liquidVolume;
    }

References LiquidFilm< Particle >::liquidVolume_.

Referenced by RotatingDrumWet::actionsAfterTimeStep(), LiquidMigrationLSInteraction::form(), LiquidMigrationWilletInteraction::form(), main(), LiquidMigrationLSInteraction::rupture(), LiquidMigrationWilletInteraction::rupture(), RotatingDrumWet::setupInitialConditions(), LiquidMigrationMPI2Test::setupInitialConditions(), LiquidMigrationSelfTest::setupInitialConditions(), DPM::setupInitialConditions(), TwoParticleElasticCollisionInteraction::setupInitialConditions(), TwoParticles::setupInitialConditions(), and EvaporationAndHeatTest::setupInitialConditions().

write()

template<class Particle >

void LiquidFilm< Particle >::write ( std::ostream &  os ) const

inlineoverride

LiquidFilm print method, which accepts an os std::ostream as input. It prints human readable LiquidFilm information to the std::ostream.

Parameters

[in,out]

os

stream to which the info is written

    {
        Particle::write(os);
        os << " liquidVolume " << liquidVolume_;
    }

References LiquidFilm< Particle >::liquidVolume_.

Member Data Documentation

liquidVolume_

template<class Particle >

Mdouble LiquidFilm< Particle >::liquidVolume_

protected

Referenced by LiquidFilm< Particle >::addLiquidVolume(), HeatFluidCoupled< Particle >::getFieldVTK(), LiquidFilm< Particle >::getLiquidVolume(), LiquidFilm< Particle >::LiquidFilm(), LiquidFilm< Particle >::setLiquidVolume(), and LiquidFilm< Particle >::write().

---

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

• LiquidFilmParticle.h