A spatially homogeneous mixture. More...

#include <Mixture.h>

Inheritance diagram for Pscf::Homogeneous::Mixture:

Public Member Functions
	Mixture ()
	Constructor. More...

	~Mixture ()
	Destructor. More...

Initialization.
virtual void	readParameters (std::istream &in)
	Read parameters from file and initialize. More...

void	setNMolecule (int nMolecule)
	Set the number of molecular species and allocate memory. More...

void	setNMonomer (int nMonomer)
	Set the number of monomer types. More...

Thermodynamics Computations
void	setComposition (DArray< double > const &phi)
	Set system composition. More...

void	computeMu (Interaction const &interaction, double xi=0.0)
	Compute chemical potential from preset composition. More...

void	computePhi (Interaction const &interaction, DArray< double > const &mu, DArray< double > const &phi, double &xi)
	Compute composition from chemical potentials. More...

void	computeFreeEnergy (Interaction const &interaction)
	Compute Helmholtz free energy and pressure. More...

Public Member Functions inherited from Util::ParamComposite
	ParamComposite ()
	Constructor. More...

	ParamComposite (const ParamComposite &other)
	Copy constructor. More...

	ParamComposite (int capacity)
	Constructor. More...

virtual	~ParamComposite ()
	Virtual destructor. More...

void	resetParam ()
	Resets ParamComposite to its empty state. More...

virtual void	readParam (std::istream &in)
	Read the parameter file block. More...

virtual void	readParamOptional (std::istream &in)
	Read optional parameter file block. More...

virtual void	writeParam (std::ostream &out) const
	Write all parameters to an output stream. More...

virtual void	load (Serializable::IArchive &ar)
	Load all parameters from an input archive. More...

virtual void	loadOptional (Serializable::IArchive &ar)
	Load an optional ParamComposite. More...

virtual void	loadParameters (Serializable::IArchive &ar)
	Load state from archive, without adding Begin and End lines. More...

virtual void	save (Serializable::OArchive &ar)
	Saves all parameters to an archive. More...

void	saveOptional (Serializable::OArchive &ar)
	Saves isActive flag, and then calls save() iff isActive is true. More...

void	readParamComposite (std::istream &in, ParamComposite &child, bool next=true)
	Add and read a required child ParamComposite. More...

void	readParamCompositeOptional (std::istream &in, ParamComposite &child, bool next=true)
	Add and attempt to read an optional child ParamComposite. More...

template<typename Type >
ScalarParam< Type > &	read (std::istream &in, const char *label, Type &value)
	Add and read a new required ScalarParam < Type > object. More...

template<typename Type >
ScalarParam< Type > &	readOptional (std::istream &in, const char *label, Type &value)
	Add and read a new optional ScalarParam < Type > object. More...

template<typename Type >
CArrayParam< Type > &	readCArray (std::istream &in, const char label, Type value, int n)
	Add and read a required C array parameter. More...

template<typename Type >
CArrayParam< Type > &	readOptionalCArray (std::istream &in, const char label, Type value, int n)
	Add and read an optional C array parameter. More...

template<typename Type >
DArrayParam< Type > &	readDArray (std::istream &in, const char *label, DArray< Type > &array, int n)
	Add and read a required DArray < Type > parameter. More...

template<typename Type >
DArrayParam< Type > &	readOptionalDArray (std::istream &in, const char *label, DArray< Type > &array, int n)
	Add and read an optional DArray < Type > parameter. More...

template<typename Type , int N>
FArrayParam< Type, N > &	readFArray (std::istream &in, const char *label, FArray< Type, N > &array)
	Add and read a required FArray < Type, N > array parameter. More...

template<typename Type , int N>
FArrayParam< Type, N > &	readOptionalFArray (std::istream &in, const char *label, FArray< Type, N > &array)
	Add and read an optional FArray < Type, N > array parameter. More...

template<typename Type , int N>
FSArrayParam< Type, N > &	readFSArray (std::istream &in, const char *label, FSArray< Type, N > &array, int size)
	Add and read a required FSArray < Type, N > array parameter. More...

template<typename Type , int N>
FSArrayParam< Type, N > &	readOptionalFSArray (std::istream &in, const char *label, FSArray< Type, N > &array, int size)
	Add and read an optional FSArray < Type, N > array parameter. More...

template<typename Type >
CArray2DParam< Type > &	readCArray2D (std::istream &in, const char label, Type value, int m, int n, int np)
	Add and read a required CArray2DParam < Type > 2D C-array. More...

template<typename Type >
CArray2DParam< Type > &	readOptionalCArray2D (std::istream &in, const char label, Type value, int m, int n, int np)
	Add and read an optional CArray2DParam < Type > 2D C-array parameter. More...

template<typename Type >
DMatrixParam< Type > &	readDMatrix (std::istream &in, const char *label, DMatrix< Type > &matrix, int m, int n)
	Add and read a required DMatrix < Type > matrix parameter. More...

template<typename Type >
DMatrixParam< Type > &	readOptionalDMatrix (std::istream &in, const char *label, DMatrix< Type > &matrix, int m, int n)
	Add and read an optional DMatrix < Type > matrix parameter. More...

template<typename Type >
DSymmMatrixParam< Type > &	readDSymmMatrix (std::istream &in, const char *label, DMatrix< Type > &matrix, int n)
	Add and read a required symmetrix DMatrix. More...

template<typename Type >
DSymmMatrixParam< Type > &	readOptionalDSymmMatrix (std::istream &in, const char *label, DMatrix< Type > &matrix, int n)
	Add and read an optional DMatrix matrix parameter. More...

Begin &	readBegin (std::istream &in, const char *label, bool isRequired=true)
	Add and read a class label and opening bracket. More...

End &	readEnd (std::istream &in)
	Add and read the closing bracket. More...

Blank &	readBlank (std::istream &in)
	Add and read a new Blank object, representing a blank line. More...

void	loadParamComposite (Serializable::IArchive &ar, ParamComposite &child, bool next=true)
	Add and load a required child ParamComposite. More...

void	loadParamCompositeOptional (Serializable::IArchive &ar, ParamComposite &child, bool next=true)
	Add and load an optional child ParamComposite if isActive. More...

template<typename Type >
ScalarParam< Type > &	loadParameter (Serializable::IArchive &ar, const char *label, Type &value, bool isRequired)
	Add and load a new ScalarParam < Type > object. More...

template<typename Type >
ScalarParam< Type > &	loadParameter (Serializable::IArchive &ar, const char *label, Type &value)
	Add and load new required ScalarParam < Type > object. More...

template<typename Type >
CArrayParam< Type > &	loadCArray (Serializable::IArchive &ar, const char label, Type value, int n, bool isRequired)
	Add a C array parameter and load its elements. More...

template<typename Type >
CArrayParam< Type > &	loadCArray (Serializable::IArchive &ar, const char label, Type value, int n)
	Add and load a required CArrayParam< Type > array parameter. More...

template<typename Type >
DArrayParam< Type > &	loadDArray (Serializable::IArchive &ar, const char *label, DArray< Type > &array, int n, bool isRequired)
	Add an load a DArray < Type > array parameter. More...

template<typename Type >
DArrayParam< Type > &	loadDArray (Serializable::IArchive &ar, const char *label, DArray< Type > &array, int n)
	Add and load a required DArray< Type > array parameter. More...

template<typename Type , int N>
FArrayParam< Type, N > &	loadFArray (Serializable::IArchive &ar, const char *label, FArray< Type, N > &array, bool isRequired)
	Add and load an FArray < Type, N > fixed-size array parameter. More...

template<typename Type , int N>
FArrayParam< Type, N > &	loadFArray (Serializable::IArchive &ar, const char *label, FArray< Type, N > &array)
	Add and load a required FArray < Type > array parameter. More...

template<typename Type , int N>
FSArrayParam< Type, N > &	loadFSArray (Serializable::IArchive &ar, const char *label, FSArray< Type, N > &array, int size, bool isRequired)
	Add and load an FSArray < Type, N > array parameter. More...

template<typename Type , int N>
FSArrayParam< Type, N > &	loadFSArray (Serializable::IArchive &ar, const char *label, FSArray< Type, N > &array, int size)
	Add and load a required FSArray < Type > array parameter. More...

template<typename Type >
CArray2DParam< Type > &	loadCArray2D (Serializable::IArchive &ar, const char label, Type value, int m, int n, int np, bool isRequired)
	Add and load a CArray2DParam < Type > C 2D array parameter. More...

template<typename Type >
CArray2DParam< Type > &	loadCArray2D (Serializable::IArchive &ar, const char label, Type value, int m, int n, int np)
	Add and load a required < Type > matrix parameter. More...

template<typename Type >
DMatrixParam< Type > &	loadDMatrix (Serializable::IArchive &ar, const char *label, DMatrix< Type > &matrix, int m, int n, bool isRequired)
	Add and load a DMatrixParam < Type > matrix parameter. More...

template<typename Type >
DMatrixParam< Type > &	loadDMatrix (Serializable::IArchive &ar, const char *label, DMatrix< Type > &matrix, int m, int n)
	Add and load a required DMatrixParam < Type > matrix parameter. More...

template<typename Type >
DSymmMatrixParam< Type > &	loadDSymmMatrix (Serializable::IArchive &ar, const char *label, DMatrix< Type > &matrix, int n, bool isRequired)
	Add and load a symmetric DSymmMatrixParam < Type > matrix parameter. More...

template<typename Type >
DSymmMatrixParam< Type > &	loadDSymmMatrix (Serializable::IArchive &ar, const char *label, DMatrix< Type > &matrix, int n)
	Add and load a required DSymmMatrixParam < Type > matrix parameter. More...

void	addParamComposite (ParamComposite &child, bool next=true)
	Add a child ParamComposite object to the format array. More...

Begin &	addBegin (const char *label)
	Add a Begin object representing a class name and bracket. More...

End &	addEnd ()
	Add a closing bracket. More...

Blank &	addBlank ()
	Create and add a new Blank object, representing a blank line. More...

std::string	className () const
	Get class name string. More...

bool	isRequired () const
	Is this ParamComposite required in the input file? More...

bool	isActive () const
	Is this parameter active? More...

Public Member Functions inherited from Util::ParamComponent
virtual	~ParamComponent ()
	Destructor. More...

virtual void	readParam (std::istream &in)=0
	Read parameter(s) from file. More...

virtual void	writeParam (std::ostream &out) const =0
	Read parameter(s) to file. More...

virtual void	load (Serializable::IArchive &ar)
	Load internal state from an archive. More...

virtual void	save (Serializable::OArchive &ar)
	Save internal state to an archive. More...

virtual void	resetParam ()
	Nontrivial implementation provided by ParamComposite subclass. More...

void	setIndent (const ParamComponent &parent, bool next=true)
	Set indent level. More...

std::string	indent () const
	Return indent string for this object (string of spaces). More...

template<class Archive >
void	serialize (Archive &ar, const unsigned int version)
	Serialize this ParamComponent as a string. More...

Public Member Functions inherited from Util::Serializable
virtual	~Serializable ()
	Destructor. More...

virtual void	save (OArchive &ar)=0
	Save to an archive. More...

virtual void	load (IArchive &ar)=0
	Load from an archive. More...

Public Member Functions inherited from Util::MpiFileIo
	MpiFileIo ()
	Constructor. More...

	MpiFileIo (const MpiFileIo &other)
	Copy constructor. More...

bool	isIoProcessor () const
	Can this processor do file I/O ? More...

void	setIoCommunicator (MPI::Intracomm &communicator)
	Set the communicator. More...

void	clearCommunicator ()
	Clear (nullify) the communicator. More...

bool	hasIoCommunicator () const
	Does this object have an associated MPI communicator? More...

MPI::Intracomm &	ioCommunicator () const
	Get the MPI communicator by reference. More...

Accessors
Molecule &	molecule (int id)
	Get a molecule object (non-const reference). More...

double	mu (int id) const
	Return chemical potential for one species. More...

double	phi (int id) const
	Return molecular volume fraction for one species. More...

double	c (int id) const
	Return monomer volume fraction for one monomer type. More...

double	fHelmholtz () const
	Return Helmholtz free energy per monomer / kT. More...

double	pressure () const
	Return pressure in units of kT / monomer volume. More...

int	nMolecule () const
	Get number of molecule species (polymer + solvent). More...

int	nMonomer () const
	Get number of monomer types. More...

void	validate () const
	Validate all data structures. More...

Additional Inherited Members
Public Types inherited from Util::Serializable
typedef BinaryFileOArchive	OArchive
	Type of output archive used by save method. More...

typedef BinaryFileIArchive	IArchive
	Type of input archive used by load method. More...

Static Public Member Functions inherited from Util::ParamComponent
static void	initStatic ()
	Initialize static echo member to false. More...

static void	setEcho (bool echo=true)
	Enable or disable echoing for all subclasses of ParamComponent. More...

static bool	echo ()
	Get echo parameter. More...

Protected Member Functions inherited from Util::ParamComposite
void	setClassName (const char *className)
	Set class name string. More...

void	setIsRequired (bool isRequired)
	Set or unset the isActive flag. More...

void	setIsActive (bool isActive)
	Set or unset the isActive flag. More...

void	setParent (ParamComponent &param, bool next=true)
	Set this to the parent of a child component. More...

void	addComponent (ParamComponent &param, bool isLeaf=true)
	Add a new ParamComponent object to the format array. More...

template<typename Type >
ScalarParam< Type > &	add (std::istream &in, const char *label, Type &value, bool isRequired=true)
	Add a new required ScalarParam < Type > object. More...

template<typename Type >
CArrayParam< Type > &	addCArray (std::istream &in, const char label, Type value, int n, bool isRequired=true)
	Add (but do not read) a required C array parameter. More...

template<typename Type >
DArrayParam< Type > &	addDArray (std::istream &in, const char *label, DArray< Type > &array, int n, bool isRequired=true)
	Add (but do not read) a DArray < Type > parameter. More...

template<typename Type , int N>
FArrayParam< Type, N > &	addFArray (std::istream &in, const char *label, FArray< Type, N > &array, bool isRequired=true)
	Add (but do not read) a FArray < Type, N > array parameter. More...

template<typename Type , int N>
FSArrayParam< Type, N > &	addFSArray (std::istream &in, const char *label, FSArray< Type, N > &array, int size, bool isRequired=true)
	Add (but do not read) a FSArray < Type, N > array parameter. More...

template<typename Type >
CArray2DParam< Type > &	addCArray2D (std::istream &in, const char label, Type value, int m, int n, int np, bool isRequired=true)
	Add (but do not read) a CArray2DParam < Type > 2D C-array. More...

template<typename Type >
DMatrixParam< Type > &	addDMatrix (std::istream &in, const char *label, DMatrix< Type > &matrix, int m, int n, bool isRequired=true)
	Add and read a required DMatrix < Type > matrix parameter. More...

Protected Member Functions inherited from Util::ParamComponent
	ParamComponent ()
	Constructor. More...

	ParamComponent (const ParamComponent &other)
	Copy constructor. More...

Detailed Description

A spatially homogeneous mixture.

Definition at line 33 of file pscf/homogeneous/Mixture.h.

Constructor & Destructor Documentation

◆ Mixture()

Pscf::Homogeneous::Mixture::Mixture ( )

Constructor.

Definition at line 21 of file pscf/homogeneous/Mixture.cpp.

References Util::ParamComposite::setClassName().

◆ ~Mixture()

Pscf::Homogeneous::Mixture::~Mixture ( )

Destructor.

Definition at line 45 of file pscf/homogeneous/Mixture.cpp.

Member Function Documentation

◆ readParameters()

void Pscf::Homogeneous::Mixture::readParameters ( std::istream & in )

virtual

Read parameters from file and initialize.

Parameters

in	input parameter file

Reimplemented from Util::ParamComposite.

Definition at line 51 of file pscf/homogeneous/Mixture.cpp.

References Util::DArray< Data >::allocate(), Util::ParamComposite::readParamComposite(), UTIL_ASSERT, and validate().

◆ setNMolecule()

void Pscf::Homogeneous::Mixture::setNMolecule ( int nMolecule )

Set the number of molecular species and allocate memory.

Parameters

nMolecule number of molecular species (polymer and solvent)

Definition at line 71 of file pscf/homogeneous/Mixture.cpp.

References Util::DArray< Data >::allocate(), nMolecule(), and UTIL_ASSERT.

Referenced by Pscf::Fd1d::System::readParameters().

◆ setNMonomer()

void Pscf::Homogeneous::Mixture::setNMonomer ( int nMonomer )

Set the number of monomer types.

Parameters

nMonomer number of monomer types.

Definition at line 80 of file pscf/homogeneous/Mixture.cpp.

References Util::DArray< Data >::allocate(), nMonomer(), and UTIL_ASSERT.

Referenced by Pscf::Fd1d::System::readParameters().

◆ setComposition()

void Pscf::Homogeneous::Mixture::setComposition ( DArray< double > const & phi )

Set system composition.

Parameters

phi	array of molecular volume fractions.

Definition at line 91 of file pscf/homogeneous/Mixture.cpp.

References phi(), UTIL_ASSERT, UTIL_CHECK, and validate().

Referenced by Pscf::Fd1d::HomogeneousComparison::compute(), and computePhi().

◆ computeMu()

void Pscf::Homogeneous::Mixture::computeMu	(	Interaction const &	interaction,
		double	xi = `0.0`
	)

Compute chemical potential from preset composition.

Precondition: setComposition must be called prior. Postcondition: Upon return, mu array is set.

Parameters

interaction	excess free energy model (input)
xi	Lagrange multiplier field (input)

Definition at line 149 of file pscf/homogeneous/Mixture.cpp.

References c(), Pscf::Homogeneous::Molecule::clump(), Pscf::Interaction::computeW(), Pscf::Homogeneous::Clump::monomerId(), mu(), Pscf::Homogeneous::Molecule::nClump(), Pscf::Interaction::nMonomer(), Pscf::Homogeneous::Clump::size(), Pscf::Homogeneous::Molecule::size(), and UTIL_CHECK.

Referenced by Pscf::Fd1d::HomogeneousComparison::compute(), and computePhi().

◆ computePhi()

void Pscf::Homogeneous::Mixture::computePhi	(	Interaction const &	interaction,
		DArray< double > const &	mu,
		DArray< double > const &	phi,
		double &	xi
	)

Compute composition from chemical potentials.

Parameters

interaction	excess free energy model (input)
mu	target molecular chemical potentials (input)
phi	guess of molecular volume fractions (input)
xi	Lagrange multiplier field (input/output)

Definition at line 178 of file pscf/homogeneous/Mixture.cpp.

References Util::DArray< Data >::allocate(), Util::DMatrix< Data >::allocate(), Pscf::LuSolver::allocate(), Util::Array< Data >::capacity(), Pscf::Homogeneous::Molecule::clump(), Pscf::Interaction::computeDwDc(), Pscf::LuSolver::computeLU(), computeMu(), molecule(), Pscf::Homogeneous::Clump::monomerId(), mu(), Pscf::Homogeneous::Molecule::nClump(), Pscf::Interaction::nMonomer(), phi(), setComposition(), Pscf::Homogeneous::Clump::size(), Pscf::Homogeneous::Molecule::size(), Pscf::LuSolver::solve(), UTIL_ASSERT, and UTIL_THROW.