Abstract base class for generating initial points for a conformalVoronoiMesh. More...

Inheritance diagram for initialPointsMethod:

[legend]

Collaboration diagram for initialPointsMethod:

[legend]

Public Member Functions
	TypeName ("initialPointsMethod")
	Runtime type information. More...

	declareRunTimeSelectionTable (autoPtr, initialPointsMethod, dictionary,(const dictionary &initialPointsDict, const Time &runTime, Random &rndGen, const conformationSurfaces &geometryToConformTo, const cellShapeControl &cellShapeControls, const autoPtr< backgroundMeshDecomposition > &decomposition),(initialPointsDict, runTime, rndGen, geometryToConformTo, cellShapeControls, decomposition))

	initialPointsMethod (const word &type, const dictionary &initialPointsDict, const Time &runTime, Random &rndGen, const conformationSurfaces &geometryToConformTo, const cellShapeControl &cellShapeControls, const autoPtr< backgroundMeshDecomposition > &decomposition)
	Construct from components. More...

	initialPointsMethod (const initialPointsMethod &)=delete
	Disallow default bitwise copy construction. More...

virtual	~initialPointsMethod ()
	Destructor. More...

const Time &	time () const

Random &	rndGen () const

const conformationSurfaces &	geometryToConformTo () const

const cellShapeControl &	cellShapeControls () const

const backgroundMeshDecomposition &	decomposition () const

const dictionary &	detailsDict () const
	Const access to the details dictionary. More...

Switch	fixInitialPoints () const

virtual List< Vb::Point >	initialPoints () const =0
	Return the initial points for the conformalVoronoiMesh. More...

void	operator= (const initialPointsMethod &)=delete
	Disallow default bitwise assignment. More...

Public Member Functions inherited from dictionary
	ClassName ("dictionary")

	dictionary ()
	Construct top-level dictionary null. More...

	dictionary (const fileName &name)
	Construct top-level empty dictionary with given name. More...

	dictionary (const fileName &name, const dictionary &parentDict, Istream &)
	Construct given the entry name, parent dictionary and Istream,. More...

	dictionary (Istream &, const bool keepHeader=false)
	Construct top-level dictionary from Istream,. More...

	dictionary (const dictionary &parentDict, const dictionary &)
	Construct as copy given the parent dictionary. More...

	dictionary (const dictionary &)
	Construct top-level dictionary as copy. More...

	dictionary (const dictionary *)
	Construct top-level dictionary as copy from pointer to dictionary. More...

	dictionary (const dictionary &parentDict, dictionary &&)
	Move constructor transferring parameter contents. More...

	dictionary (dictionary &&)
	Move constructor. More...

autoPtr< dictionary >	clone () const
	Construct and return clone. More...

virtual	~dictionary ()
	Destructor. More...

const dictionary &	parent () const
	Return the parent dictionary. More...

bool	isNull () const
	Return whether this dictionary is null. More...

const dictionary &	topDict () const
	Return the top of the tree. More...

word	topDictKeyword () const
	Return the scoped keyword with which this dictionary can be. More...

label	startLineNumber () const
	Return line number of first token in dictionary. More...

label	endLineNumber () const
	Return line number of last token in dictionary. More...

SHA1Digest	digest () const
	Return the SHA1 digest of the dictionary contents. More...

tokenList	tokens () const
	Return the dictionary as a list of tokens. More...

bool	found (const word &, bool recursive=false, bool patternMatch=true) const
	Search dictionary for given keyword. More...

const entry *	lookupEntryPtr (const word &, bool recursive, bool patternMatch) const
	Find and return an entry data stream pointer if present. More...

entry *	lookupEntryPtr (const word &, bool recursive, bool patternMatch)
	Find and return an entry data stream pointer for manipulation. More...

const entry *	lookupEntryPtrBackwardsCompatible (const wordList &, bool recursive, bool patternMatch) const
	Find and return an entry data stream if present, trying a list. More...

const entry &	lookupEntry (const word &, bool recursive, bool patternMatch) const
	Find and return an entry data stream if present otherwise error. More...

const entry &	lookupEntryBackwardsCompatible (const wordList &, bool recursive, bool patternMatch) const
	Find and return an entry data stream if present, trying a list. More...

ITstream &	lookup (const word &, bool recursive=false, bool patternMatch=true) const
	Find and return an entry data stream. More...

ITstream &	lookupBackwardsCompatible (const wordList &, bool recursive=false, bool patternMatch=true) const
	Find and return an entry data stream, trying a list of keywords. More...

template<class T >
T	lookup (const word &, bool recursive=false, bool patternMatch=true) const
	Find and return a T,. More...

template<class T >
T	lookupBackwardsCompatible (const wordList &, bool recursive=false, bool patternMatch=true) const
	Find and return a T, trying a list of keywords in sequence. More...

template<class T >
T	lookupOrDefault (const word &, const T &, bool recursive=false, bool patternMatch=true) const
	Find and return a T,. More...

template<class T >
T	lookupOrDefaultBackwardsCompatible (const wordList &, const T &, bool recursive=false, bool patternMatch=true) const
	Find and return a T, trying a list of keywords in sequence. More...

template<class T >
T	lookupOrAddDefault (const word &, const T &, bool recursive=false, bool patternMatch=true)
	Find and return a T, if not found return the given. More...

template<class T >
bool	readIfPresent (const word &, T &, bool recursive=false, bool patternMatch=true) const
	Find an entry if present, and assign to T. More...

const entry *	lookupScopedEntryPtr (const word &, bool recursive, bool patternMatch) const
	Find and return an entry data stream pointer if present. More...

bool	isDict (const word &) const
	Check if entry is a sub-dictionary. More...

const dictionary *	subDictPtr (const word &) const
	Find and return a sub-dictionary pointer if present. More...

dictionary *	subDictPtr (const word &)
	Find and return a sub-dictionary pointer if present. More...

const dictionary &	subDict (const word &) const
	Find and return a sub-dictionary. More...

dictionary &	subDict (const word &)
	Find and return a sub-dictionary for manipulation. More...

dictionary	subOrEmptyDict (const word &, const bool mustRead=false) const
	Find and return a sub-dictionary as a copy, or. More...

const dictionary &	optionalSubDict (const word &) const
	Find and return a sub-dictionary if found. More...

const dictionary &	scopedDict (const word &) const
	Find and return a sub-dictionary by scoped lookup. More...

dictionary &	scopedDict (const word &)
	Find and return a sub-dictionary by scoped lookup. More...

wordList	toc () const
	Return the table of contents. More...

wordList	sortedToc () const
	Return the sorted table of contents. More...

List< keyType >	keys (bool patterns=false) const
	Return the list of available keys or patterns. More...

bool	substituteKeyword (const word &keyword)
	Substitute the given keyword prepended by '$' with the. More...

bool	substituteScopedKeyword (const word &keyword)
	Substitute the given scoped keyword prepended by '$' with the. More...

bool	add (entry *, bool mergeEntry=false)
	Add a new entry. More...

void	add (const entry &, bool mergeEntry=false)
	Add an entry. More...

void	add (const keyType &, const word &, bool overwrite=false)
	Add a word entry. More...

void	add (const keyType &, const string &, bool overwrite=false)
	Add a string entry. More...

void	add (const keyType &, const label, bool overwrite=false)
	Add a label entry. More...

void	add (const keyType &, const scalar, bool overwrite=false)
	Add a scalar entry. More...

void	add (const keyType &, const dictionary &, bool mergeEntry=false)
	Add a dictionary entry. More...

template<class T >
void	add (const keyType &, const T &, bool overwrite=false)
	Add a T entry. More...

void	set (entry *)
	Assign a new entry, overwrite any existing entry. More...

void	set (const entry &)
	Assign a new entry, overwrite any existing entry. More...

void	set (const keyType &, const dictionary &)
	Assign a dictionary entry, overwrite any existing entry. More...

template<class T >
void	set (const keyType &, const T &)
	Assign a T entry, overwrite any existing entry. More...

bool	remove (const word &)
	Remove an entry specified by keyword. More...

bool	changeKeyword (const keyType &oldKeyword, const keyType &newKeyword, bool forceOverwrite=false)
	Change the keyword for an entry,. More...

bool	merge (const dictionary &)
	Merge entries from the given dictionary. More...

void	clear ()
	Clear the dictionary. More...

void	transfer (dictionary &)
	Transfer the contents of the argument and annul the argument. More...

bool	read (Istream &, const bool keepHeader=false)
	Read dictionary from Istream, optionally keeping the header. More...

virtual bool	global () const
	Return true if the dictionary global,. More...

void	write (Ostream &, const bool subDict=true) const
	Write dictionary, normally with sub-dictionary formatting. More...

ITstream &	operator[] (const word &) const
	Find and return entry. More...

void	operator= (const dictionary &)

void	operator= (dictionary &&)

void	operator+= (const dictionary &)
	Include entries from the given dictionary. More...

void	operator\|= (const dictionary &)
	Conditionally include entries from the given dictionary. More...

void	operator<<= (const dictionary &)
	Unconditionally include entries from the given dictionary. More...

Public Member Functions inherited from dictionaryName
	dictionaryName ()
	Construct dictionaryName null. More...

	dictionaryName (const fileName &name)
	Construct dictionaryName as copy of the given fileName. More...

	dictionaryName (dictionaryName &&name)
	Move constructor. More...

const fileName &	name () const
	Return the dictionary name. More...

fileName &	name ()
	Return the dictionary name. More...

const word	dictName () const
	Return the local dictionary name (final part of scoped name) More...

void	operator= (const dictionaryName &name)

void	operator= (dictionaryName &&name)

Public Member Functions inherited from ILList< LListBase, T >
	ILList ()
	Null construct. More...

	ILList (T *a)
	Construct given initial T. More...

	ILList (Istream &)
	Construct from Istream. More...

	ILList (const ILList< LListBase, T > &)
	Copy constructor. More...

	ILList (ILList< LListBase, T > &&)
	Move constructor. More...

template<class CloneArg >
	ILList (const ILList< LListBase, T > &lst, const CloneArg &cloneArg)
	Copy constructor with additional argument for clone. More...

template<class INew >
	ILList (Istream &, const INew &)
	Construct from Istream using given Istream constructor class. More...

	~ILList ()
	Destructor. More...

bool	eraseHead ()
	Remove the head element specified from the list and delete it. More...

bool	erase (T *p)
	Remove the specified element from the list and delete it. More...

void	clear ()
	Clear the contents of the list. More...

void	transfer (ILList< LListBase, T > &)
	Transfer the contents of the argument into this List. More...

void	operator= (const ILList< LListBase, T > &)
	Assignment operator. More...

void	operator= (ILList< LListBase, T > &&)
	Move assignment operator. More...

Public Member Functions inherited from UILList< LListBase, T >
	UILList ()
	Null construct. More...

	UILList (T *a)
	Construct given initial T. More...

	UILList (const UILList< LListBase, T > &)
	Copy constructor. More...

	UILList (UILList< LListBase, T > &&)
	Move constructor. More...

T *	first ()
	Return the first entry. More...

const T *	first () const
	Return the first entry. More...

T *	last ()
	Return the last entry. More...

const T *	last () const
	Return the last entry. More...

T *	removeHead ()
	Remove and return head. More...

T *	remove (T *p)
	Remove and return element. More...

T *	remove (iterator &it)
	Remove and return specified by iterator. More...

void	operator= (const UILList< LListBase, T > &)
	Assignment operator. More...

void	operator= (UILList< LListBase, T > &&)
	Move assignment operator. More...

iterator	begin ()

const iterator &	end ()

const_iterator	cbegin () const

const const_iterator &	cend () const

const_iterator	begin () const

const const_iterator &	end () const

const_reverse_iterator	crbegin () const

const const_reverse_iterator &	crend () const

const_reverse_iterator	rbegin () const

const const_reverse_iterator &	rend () const

bool	operator== (const UILList< LListBase, T > &) const
	Equality operation on ULists of the same type. More...

bool	operator!= (const UILList< LListBase, T > &) const
	The opposite of the equality operation. Takes linear time. More...

Static Public Member Functions
static autoPtr< initialPointsMethod >	New (const dictionary &initialPointsDict, const Time &runTime, Random &rndGen, const conformationSurfaces &geometryToConformTo, const cellShapeControl &cellShapeControls, const autoPtr< backgroundMeshDecomposition > &decomposition)
	Return a reference to the selected initialPointsMethod. More...

Static Public Member Functions inherited from dictionary
static autoPtr< dictionary >	New (Istream &)
	Construct top-level dictionary on freestore from Istream. More...

Protected Attributes
const Time &	runTime_

Random &	rndGen_

const conformationSurfaces &	geometryToConformTo_

const cellShapeControl &	cellShapeControls_

const autoPtr< backgroundMeshDecomposition > &	decomposition_

dictionary	detailsDict_
	Method details dictionary. More...

scalar	minimumSurfaceDistanceCoeffSqr_
	Only allow the placement of initial points that are within the. More...

Switch	fixInitialPoints_

Additional Inherited Members
Public Types inherited from UILList< LListBase, T >
typedef T	value_type
	Type of values the DLList contains. More...

typedef T &	reference
	Type that can be used for storing into DLList::value_type. More...

typedef const T &	const_reference
	Type that can be used for storing into constant. More...

typedef label	size_type
	The type that can represent the size of a DLList. More...

typedef LListBase::iterator	LListBase_iterator

typedef LListBase::const_iterator	LListBase_const_iterator

Static Public Attributes inherited from dictionary
static const dictionary	null
	Null dictionary. More...

static bool	writeOptionalEntries
	If true write optional keywords and values. More...

Detailed Description

Abstract base class for generating initial points for a conformalVoronoiMesh.

Source files

Definition at line 55 of file initialPointsMethod.H.

Constructor & Destructor Documentation

◆ initialPointsMethod() [1/2]

initialPointsMethod	(	const word &	type,
		const dictionary &	initialPointsDict,
		const Time &	runTime,
		Random &	rndGen,
		const conformationSurfaces &	geometryToConformTo,
		const cellShapeControl &	cellShapeControls,
		const autoPtr< backgroundMeshDecomposition > &	decomposition
	)

Construct from components.

◆ initialPointsMethod() [2/2]

initialPointsMethod ( const initialPointsMethod & )

delete

Disallow default bitwise copy construction.

◆ ~initialPointsMethod()

virtual ~initialPointsMethod ( )

virtual

Destructor.

Member Function Documentation

◆ TypeName()

TypeName ( "initialPointsMethod" )

Runtime type information.

◆ declareRunTimeSelectionTable()

declareRunTimeSelectionTable	(	autoPtr	,
		initialPointsMethod	,
		dictionary	,
		(const dictionary &initialPointsDict, const Time &runTime, Random &rndGen, const conformationSurfaces &geometryToConformTo, const cellShapeControl &cellShapeControls, const autoPtr< backgroundMeshDecomposition > &decomposition)	,
		(initialPointsDict, runTime, rndGen, geometryToConformTo, cellShapeControls, decomposition)
	)

◆ New()

static autoPtr<initialPointsMethod> New	(	const dictionary &	initialPointsDict,
		const Time &	runTime,
		Random &	rndGen,
		const conformationSurfaces &	geometryToConformTo,
		const cellShapeControl &	cellShapeControls,
		const autoPtr< backgroundMeshDecomposition > &	decomposition
	)