Choose random points inside the domain and place them with a probability proportional to the target density of points. More...

Inheritance diagram for autoDensity:

[legend]

Collaboration diagram for autoDensity:

[legend]

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

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

virtual	~autoDensity ()
	Destructor. More...

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

Public Member Functions inherited from initialPointsMethod
	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...

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

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 &)
	Construct top-level dictionary from Istream,. More...

	dictionary (Istream &, const bool keepHeader)
	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, const Xfer< dictionary > &)
	Construct by transferring parameter contents given parent dictionary. More...

	dictionary (const Xfer< dictionary > &)
	Construct top-level dictionary by transferring parameter contents. More...

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

virtual	~dictionary ()
	Destructor. More...

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

const dictionary &	topDict () const
	Return the top of the tree. 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 &	lookupEntry (const word &, bool recursive, bool patternMatch) const
	Find and return an entry data stream if present otherwise error. More...

ITstream &	lookup (const word &, bool recursive=false, bool patternMatch=true) const
	Find and return an entry data stream. 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	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...

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

wordList	toc () const
	Return the 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...

Xfer< dictionary >	xfer ()
	Transfer contents to the Xfer container. More...

bool	read (Istream &)
	Read dictionary from Istream. More...

bool	read (Istream &, const bool keepHeader)
	Read dictionary from Istream, optionally keeping the header. 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+= (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...

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

Public Member Functions inherited from IDLList< entry >
	IDLList ()
	Null construct. More...

	IDLList (const entry &a)
	Construct given initial T. More...

	IDLList (Istream &is, const INew &inewt)
	Construct from Istream using given Istream constructor class. More...

	IDLList (Istream &is)
	Construct from Istream. More...

	IDLList (const IDLList< entry > &idll, const CloneArg &cloneArg)
	Copy constructor with additional argument for clone. More...

Public Member Functions inherited from ILList< DLListBase, entry >
	ILList ()
	Null construct. More...

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

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

	ILList (const ILList< LListBase, T > &)
	Construct as copy. More...

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

	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 > &)

Private Member Functions
bool	combinedOverlaps (const treeBoundBox &box) const
	Check if the given box overlaps the geometry or, in parallel, the. More...

bool	combinedInside (const point &p) const
	Check if the given point is inside the geometry and, in parallel,. More...

Field< bool >	combinedWellInside (const pointField &pts, const scalarField &sizes) const
	Check if the given points are wellInside the geometry and, in. More...

bool	combinedWellInside (const point &p, scalar size) const
	Check if the given points are wellInside the geometry and, in. More...

void	writeOBJ (const treeBoundBox &bb, fileName name) const
	Write boundBox as obj. More...

label	recurseAndFill (DynamicList< Vb::Point > &initialPoints, const treeBoundBox &bb, label levelLimit, word recursionName) const
	Descend into octants of the supplied bound box. More...

bool	fillBox (DynamicList< Vb::Point > &initialPoints, const treeBoundBox &bb, bool overlapping) const
	Fill the given box, optionally filling surface overlapping boxes. More...

Private Attributes
label	globalTrialPoints_
	Trial points attempted to be placed in all boxes. More...

scalar	minCellSizeLimit_
	Smallest minimum cell size allowed, i.e. to avoid high initial. More...

label	minLevels_
	Minimum normal level of recursion, can be more if a high density. More...

scalar	maxSizeRatio_
	Maximum allowed ratio of cell size in a box. More...

label	volRes_
	How fine should the initial sample of the volume a box be to. More...

label	surfRes_
	How fine should the initial sample of the surface of a box be to. More...

Additional Inherited Members
Static Public Member Functions inherited from initialPointsMethod
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...

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

Protected Attributes inherited from initialPointsMethod
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_

Detailed Description

Choose random points inside the domain and place them with a probability proportional to the target density of points.

Source files

Definition at line 50 of file autoDensity.H.

Constructor & Destructor Documentation

◆ autoDensity()

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

Construct from components.

◆ ~autoDensity()

virtual ~autoDensity ( )

inlinevirtual

Destructor.

Definition at line 155 of file autoDensity.H.

Member Function Documentation

◆ combinedOverlaps()

bool combinedOverlaps ( const treeBoundBox & box ) const

private

Check if the given box overlaps the geometry or, in parallel, the.

backgroundMeshDecomposition

◆ combinedInside()

bool combinedInside ( const point & p ) const

private

Check if the given point is inside the geometry and, in parallel,.

the backgroundMeshDecomposition

◆ combinedWellInside() [1/2]

Field<bool> combinedWellInside	(	const pointField &	pts,
		const scalarField &	sizes
	)		const

private

Check if the given points are wellInside the geometry and, in.

parallel, inside the backgroundMeshDecomposition

◆ combinedWellInside() [2/2]

bool combinedWellInside	(	const point &	p,
		scalar	size
	)		const

private

Check if the given points are wellInside the geometry and, in.

parallel, inside the backgroundMeshDecomposition

◆ writeOBJ()

void writeOBJ	(	const treeBoundBox &	bb,
		fileName	name
	)		const

private

Write boundBox as obj.

◆ recurseAndFill()

label recurseAndFill	(	DynamicList< Vb::Point > &	initialPoints,
		const treeBoundBox &	bb,
		label	levelLimit,
		word	recursionName
	)		const

private

Descend into octants of the supplied bound box.

◆ fillBox()

bool fillBox	(	DynamicList< Vb::Point > &	initialPoints,
		const treeBoundBox &	bb,
		bool	overlapping
	)		const

private

Fill the given box, optionally filling surface overlapping boxes.

Returns true if the fill is successful, false if it is to be aborted in favour of further recursion.

◆ TypeName()

TypeName ( "autoDensity" )

Runtime type information.

◆ initialPoints()

virtual List<Vb::Point> initialPoints ( ) const

virtual

Return the initial points for the conformalVoronoiMesh.

Implements initialPointsMethod.

Field Documentation

◆ globalTrialPoints_

label globalTrialPoints_

mutableprivate

Trial points attempted to be placed in all boxes.

Definition at line 60 of file autoDensity.H.

◆ minCellSizeLimit_

scalar minCellSizeLimit_

private

Smallest minimum cell size allowed, i.e. to avoid high initial.

population of areas of small size

Definition at line 64 of file autoDensity.H.

◆ minLevels_

label minLevels_

private

Minimum normal level of recursion, can be more if a high density.

ratio is detected

Definition at line 68 of file autoDensity.H.

◆ maxSizeRatio_

scalar maxSizeRatio_

private

Maximum allowed ratio of cell size in a box.

Definition at line 71 of file autoDensity.H.

◆ volRes_

label volRes_

private

How fine should the initial sample of the volume a box be to.

investigate its cell sizes and volume fraction

Definition at line 75 of file autoDensity.H.

◆ surfRes_

label surfRes_

private

How fine should the initial sample of the surface of a box be to.

investigate if it is near to a the geometry.

Definition at line 79 of file autoDensity.H.

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

applications/utilities/mesh/generation/foamyMesh/conformalVoronoiMesh/initialPointsMethod/autoDensity/autoDensity.H

Public Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ autoDensity()

◆ ~autoDensity()

Member Function Documentation

◆ combinedOverlaps()

◆ combinedInside()

◆ combinedWellInside() [1/2]

◆ combinedWellInside() [2/2]

◆ writeOBJ()

◆ recurseAndFill()

◆ fillBox()

◆ TypeName()

◆ initialPoints()

Field Documentation

◆ globalTrialPoints_

◆ minCellSizeLimit_

◆ minLevels_

◆ maxSizeRatio_

◆ volRes_

◆ surfRes_