This class defines all the necessary enteties for defining an insertion region. More...

Inheritance diagram for insertionRegion:

Collaboration diagram for insertionRegion:

Public Member Functions
	TypeInfoNV ("insertionRegion")
	Type info. More...

	insertionRegion (const word &name, const insertion &instn)
	Construct from a dictionary. More...

	~insertionRegion ()=default
	Destructor. More...

const auto &	name () const
	Const ref to name of the region. More...

const auto &	type () const
	return type of insertion region More...

const auto &	dict () const

const auto &	Insertion () const

const pointStructure &	pStruct () const

bool	insertionTime (uint32 iter, real t, real dt) const

uint32	numberToBeInserted (uint32 iter, real t, real dt)

uint32	addToNumInserted (uint32 newInserted)

uint32	totalInserted () const

auto &	mixture ()

auto &	pRegion ()

const auto &	setFieldList () const

bool	write (dictionary &dict) const
	read from dictionary More...

Private Member Functions
bool	readInsertionRegion (const dictionary &dict)
	read from dictionary More...

bool	writeInsertionRegion (dictionary &dict) const
	write to dictionary More...

bool	readSetFieldDict ()

Private Attributes
const word	name_
	name of this region More...

const dictionary &	dict_
	insertion region dictionary More...

const insertion &	insertion_
	ref to insertion More...

baseTimeControl	tControl_
	time control for insertion events More...

real	rate_
	rate of insertion More...

uint32	numInserted_ = 0
	number of inserted particles More...

word	type_
	type of insertion region More...

uniquePtr< peakableRegion >	pRegion_ = nullptr
	peakable region of points More...

uniquePtr< shapeMixture >	mixture_ = nullptr
	mixture of shapes More...

uniquePtr< dictionary >	setFieldDict_ = nullptr
	dictionary for set field More...

anyList	setFieldList_
	list of (filedName type value) for the fields More...

Detailed Description

This class defines all the necessary enteties for defining an insertion region.

Insertion region information are supplied through a dictionary in a file. For example:

{
    type        cylinderRegion; // type of insertion region
    rate        15000;  // insertion rate (particles/s)
    startTime   0;      // (s)
    endTime     0.5;    // (s)
    interval    0.025;  // (s)

    cylinderRegionInfo
    {
        radius  0.09;           // radius of cylinder (m)
        p1      (0.0 0.0 0.10); // (m,m,m)
        p2      (0.0 0.0 0.11); // (m,m,m)
    }

    setFields
    {
        velocity    realx3 (0.0 0.0 -0.6); // initial velocity of inserted
particles
    }

    mixture
    {
        lightSphere 1; // mixture composition of inserted particles
    }
}

More information on the above dictionary entries can be found in the table below.

Parameter	Type	Description	Optional [default value]
type	word	type of the insertion region with name ###	No
rate	real	rate of insertion (particle/s)	No
startTime	real	start of insertion (s)	No
endTime	real	end of insertion (s)	No
interval	real	time interval between successive insertions (s)	No
###Info	dictionary	data for insertion region	No
setFields	dictionary	set field for inserted particles (s)	Yes [empty