User-input data for particle zone. More...

#include <zoneDeck.h>

Collaboration diagram for inp::ParticleZone:

Public Member Functions
	ParticleZone ()
	Constructor.

	ParticleZone (const ParticleZone &pz)
	Copy constructor.

std::string	printStr (int nt=0, int lvl=0) const
	Returns the string containing printable information about the object.

void	print (int nt=0, int lvl=0) const
	Prints the information about the object.

Data Fields
inp::Zone	d_zone
	Zone data.

std::string	d_particleDescription
	Particle information. E.g., "rigid". If nothing specific is available, value will be empty string.

bool	d_isWall
	Is this particle actually a wall?

util::geometry::GeomData	d_particleGeomData
	Geometry of details of particle.

util::geometry::GeomData	d_refParticleGeomData
	Geometry of details of reference particle.

std::string	d_genMethod
	Particle generation method.

std::string	d_particleFileDataType
	Specify what data to be expected in the particle file e.g.

std::string	d_particleFile
	Read particle from a file.

inp::MaterialDeck	d_matDeck
	Store material information.

inp::MeshDeck	d_meshDeck
	Store mesh information.

bool	d_meshFlag
	Specify if we mesh particle (intended to handle rigid wall in future)

bool	d_allDofsConstrained
	Specify if all dofs are constrained.

double	d_nearBdNodesTol
	Specify how deep we search for nodes near boundary for contact calculations.

bool	d_createParticleUsingParticleZoneGeomObject
	Specify if the particle should be created using the particle geometry in the zone data and mesh file. I.e., we will not expect location information from the particle generation file for this particle and create particle in this zone using the particle geometry object 'd_geom_p' and use identity transform.

Detailed Description

User-input data for particle zone.

Definition at line 78 of file zoneDeck.h.

Constructor & Destructor Documentation

◆ ParticleZone() [1/2]

inp::ParticleZone::ParticleZone ( )

inline

Constructor.

Definition at line 147 of file zoneDeck.h.

      : d_zone(inp::Zone()),
        d_particleDescription(""),
        d_isWall(false),
        d_particleGeomData(),
        d_refParticleGeomData(),
        d_genMethod(""),
        d_particleFileDataType(""),
        d_particleFile(""),
        d_matDeck(),
        d_meshDeck(),
        d_meshFlag(true),
        d_allDofsConstrained(false),
        d_nearBdNodesTol(0.5),
        d_createParticleUsingParticleZoneGeomObject (false)
        {};

◆ ParticleZone() [2/2]

inp::ParticleZone::ParticleZone ( const ParticleZone & pz )

inline

Copy constructor.

Parameters

pz	Another ParticleZone object

Definition at line 169 of file zoneDeck.h.

      : d_zone(pz.d_zone),
        d_particleDescription(pz.d_particleDescription),
        d_isWall(pz.d_isWall),
        d_particleGeomData(pz.d_particleGeomData),
        d_refParticleGeomData(pz.d_refParticleGeomData),
        d_genMethod(pz.d_genMethod),
        d_particleFileDataType(pz.d_particleFileDataType),
        d_particleFile(pz.d_particleFile),
        d_matDeck(pz.d_matDeck),
        d_meshDeck(pz.d_meshDeck),
        d_meshFlag(pz.d_meshFlag),
        d_allDofsConstrained(pz.d_allDofsConstrained),
        d_nearBdNodesTol(pz.d_nearBdNodesTol),
        d_createParticleUsingParticleZoneGeomObject(pz.d_createParticleUsingParticleZoneGeomObject)
        {};

Member Function Documentation

◆ print()

void inp::ParticleZone::print	(	int	nt = `0`,
		int	lvl = `0`
	)		const

inline

Prints the information about the object.

Parameters

nt	Number of tabs to append before printing
lvl	Information level (higher means more information)

Definition at line 223 of file zoneDeck.h.

223{ std::cout << printStr(nt, lvl); }

inp::ParticleZone::printStr

std::string printStr(int nt=0, int lvl=0) const

Returns the string containing printable information about the object.

Definition zoneDeck.h:193

References printStr().

Here is the call graph for this function:

◆ printStr()

std::string inp::ParticleZone::printStr	(	int	nt = `0`,
		int	lvl = `0`
	)		const

inline

Returns the string containing printable information about the object.

Parameters

nt	Number of tabs to append before printing
lvl	Information level (higher means more information)

Returns: string String containing printable information about the object

Definition at line 193 of file zoneDeck.h.

                                                    {
 
    auto tabS = util::io::getTabS(nt);
    std::ostringstream oss;
    oss << tabS << "------- ParticleZone --------" << std::endl << std::endl;
    oss << tabS << "Zone info: " << std::endl;
    oss << d_zone.printStr(nt+1, lvl);
    oss << tabS << "Particle type = " << d_particleDescription << std::endl;
    oss << tabS << "Generation method = " << d_genMethod << std::endl;
    oss << tabS << "Bdry nodes tol = " << d_nearBdNodesTol << std::endl;
    oss << tabS << "Mesh flag = " << d_meshFlag << std::endl;
    oss << tabS << "All dofs constrained = " << d_allDofsConstrained << std::endl;
    oss << tabS << "d_createParticleUsingParticleZoneGeomObject = " << d_createParticleUsingParticleZoneGeomObject << std::endl;
    oss << tabS << "Particle geometry details: " << std::endl;
    oss << d_particleGeomData.printStr(nt+1, lvl);
    oss << tabS << "Reference rarticle geometry details: " << std::endl;
    oss << d_refParticleGeomData.printStr(nt+1, lvl);
    oss << d_matDeck.printStr(nt+1, lvl);
    oss << d_meshDeck.printStr(nt+1, lvl);
    oss << std::endl;
 
    return oss.str();
  }

References d_allDofsConstrained, d_createParticleUsingParticleZoneGeomObject, d_genMethod, d_matDeck, d_meshDeck, d_meshFlag, d_nearBdNodesTol, d_particleDescription, d_particleGeomData, d_refParticleGeomData, d_zone, util::io::getTabS(), inp::MaterialDeck::printStr(), inp::MeshDeck::printStr(), inp::Zone::printStr(), and util::geometry::GeomData::printStr().

Referenced by print().

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

◆ d_allDofsConstrained

bool inp::ParticleZone::d_allDofsConstrained

Specify if all dofs are constrained.

Definition at line 130 of file zoneDeck.h.

Referenced by printStr(), and inp::Input::setParticleData().

◆ d_createParticleUsingParticleZoneGeomObject

bool inp::ParticleZone::d_createParticleUsingParticleZoneGeomObject

Specify if the particle should be created using the particle geometry in the zone data and mesh file. I.e., we will not expect location information from the particle generation file for this particle and create particle in this zone using the particle geometry object 'd_geom_p' and use identity transform.

Definition at line 142 of file zoneDeck.h.

Referenced by printStr(), and inp::Input::setParticleData().

◆ d_genMethod

std::string inp::ParticleZone::d_genMethod

Particle generation method.

"from_file" means particle location, radius and other details will be loaded from the input .csv file

Definition at line 104 of file zoneDeck.h.

Referenced by printStr(), and inp::Input::setParticleData().

◆ d_isWall

bool inp::ParticleZone::d_isWall

Is this particle actually a wall?

Definition at line 90 of file zoneDeck.h.

Referenced by inp::Input::setParticleData().

◆ d_matDeck

inp::MaterialDeck inp::ParticleZone::d_matDeck

Store material information.

Definition at line 121 of file zoneDeck.h.

Referenced by printStr().

◆ d_meshDeck

inp::MeshDeck inp::ParticleZone::d_meshDeck

Store mesh information.

Definition at line 124 of file zoneDeck.h.

Referenced by printStr().

◆ d_meshFlag

bool inp::ParticleZone::d_meshFlag

Specify if we mesh particle (intended to handle rigid wall in future)

Definition at line 127 of file zoneDeck.h.

Referenced by printStr().

◆ d_nearBdNodesTol

double inp::ParticleZone::d_nearBdNodesTol

Specify how deep we search for nodes near boundary for contact calculations.

Definition at line 133 of file zoneDeck.h.

Referenced by printStr(), and inp::Input::setParticleData().

◆ d_particleDescription

std::string inp::ParticleZone::d_particleDescription

Particle information. E.g., "rigid". If nothing specific is available, value will be empty string.

Definition at line 87 of file zoneDeck.h.

Referenced by printStr().

◆ d_particleFile

std::string inp::ParticleZone::d_particleFile

Read particle from a file.

Definition at line 118 of file zoneDeck.h.

Referenced by inp::Input::setParticleData().

◆ d_particleFileDataType

std::string inp::ParticleZone::d_particleFileDataType

Specify what data to be expected in the particle file e.g.

loc_rad : location and radius data
loc_rad_orient: location, radius, and orientation

By default, zone_id of particle will be there. Total data in each row will be 5 for "loc_rad" (1 zone, 3 location, 1 radius). For "loc_rad_orient", 6 data will be expected.

Definition at line 115 of file zoneDeck.h.

Referenced by inp::Input::setParticleData().

◆ d_particleGeomData

util::geometry::GeomData inp::ParticleZone::d_particleGeomData

Geometry of details of particle.

Definition at line 93 of file zoneDeck.h.

Referenced by printStr(), and inp::Input::setParticleData().

◆ d_refParticleGeomData

util::geometry::GeomData inp::ParticleZone::d_refParticleGeomData

Geometry of details of reference particle.

Definition at line 96 of file zoneDeck.h.

Referenced by printStr(), and inp::Input::setParticleData().

◆ d_zone

inp::Zone inp::ParticleZone::d_zone

Zone data.

Definition at line 81 of file zoneDeck.h.

Referenced by printStr().

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

/home/user/project/src/inp/pdecks/zoneDeck.h

Public Member Functions

Data Fields

Detailed Description

Constructor & Destructor Documentation

◆ ParticleZone() [1/2]

◆ ParticleZone() [2/2]

Member Function Documentation

◆ print()

◆ printStr()

Field Documentation

◆ d_allDofsConstrained

◆ d_createParticleUsingParticleZoneGeomObject

◆ d_genMethod

◆ d_isWall

◆ d_matDeck

◆ d_meshDeck

◆ d_meshFlag

◆ d_nearBdNodesTol

◆ d_particleDescription

◆ d_particleFile

◆ d_particleFileDataType

◆ d_particleGeomData

◆ d_refParticleGeomData

◆ d_zone