Pscf::FhClump Class Reference

Sub-unit of a molecule in Flory-Huggins theory. More...

#include <FhClump.h>

Public Member Functions
	FhClump ()
	Constructor.
template<class Archive>
void	serialize (Archive &ar, unsigned int versionId)
	Serialize to/from archive.
Setters
void	setMonomerId (int monomerId)
	Set the monomer type id.
void	setSize (double size)
	Set the size of this clump.

Accessors
int	monomerId () const
	Get the monomer type id.
double	size () const
	Get the size (number of monomers) in this block.
std::istream &	operator>> (std::istream &in, FhClump &block)
	istream extractor for a FhClump.
std::ostream &	operator<< (std::ostream &out, const FhClump &block)
	ostream inserter for a FhClump.

Detailed Description

Sub-unit of a molecule in Flory-Huggins theory.

A clump is an aggregate of all monomers of a specified type within a molecule. A clump has a monomer id and a size. The size of a clump is the total volume occupied by all monomers of the specified type in a molecule of a specific species, divided by the monomer reference volume.

For a block copolymer, a clump is generally different than a block because a clump may include the monomers in two or more blocks of the same monomer type. Hompolymer and solvent molecular species each have only one clump.

Definition at line 35 of file FhClump.h.

Constructor & Destructor Documentation

FhClump()

Pscf::FhClump::FhClump

(

)

Constructor.

Definition at line 15 of file FhClump.cpp.

Referenced by operator<<, and operator>>.

Member Function Documentation

serialize()

template<class Archive>

void Pscf::FhClump::serialize	(	Archive &	ar,
		unsigned int	versionId )

Serialize to/from archive.

Parameters

ar	input or output Archive
versionId	archive format version index

Definition at line 140 of file FhClump.h.

setMonomerId()

void Pscf::FhClump::setMonomerId

(

int

monomerId

)

Set the monomer type id.

Parameters

monomerId

integer id of monomer type (>=0)

Definition at line 23 of file FhClump.cpp.

References monomerId().

Referenced by Pscf::FhMixture::initialize().

setSize()

void Pscf::FhClump::setSize

(

double

size

)

Set the size of this clump.

The ``size" is steric volume / reference volume.

Parameters

size	clump size (volume / monomer volume)

Definition at line 29 of file FhClump.cpp.

References size().

Referenced by Pscf::FhMixture::initialize().

monomerId()

int Pscf::FhClump::monomerId ( ) const

inline

Get the monomer type id.

Definition at line 127 of file FhClump.h.

Referenced by Pscf::FhMixture::computeMu(), Pscf::FhMixture::computePhi(), setMonomerId(), and Pscf::FhMixture::validate().

size()

double Pscf::FhClump::size ( ) const

inline

Get the size (number of monomers) in this block.

Definition at line 133 of file FhClump.h.

Referenced by Pscf::FhMixture::computeMu(), Pscf::FhMixture::computePhi(), and setSize().

Friends And Related Symbol Documentation

operator>>

std::istream & operator>> ( std::istream & in, FhClump & block )

friend

istream extractor for a FhClump.

Parameters

in	input stream
block	FhClump to be read from stream

Returns

modified input stream

Definition at line 35 of file FhClump.cpp.

References FhClump().

operator<<

std::ostream & operator<< ( std::ostream & out, const FhClump & block )

friend

ostream inserter for a FhClump.

Parameters

out	output stream
block	FhClump to be written to stream

Returns

modified output stream

Definition at line 45 of file FhClump.cpp.

References FhClump().

---

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

• FhClump.h
• FhClump.cpp