Driver for computing a time history from a set of eigen mode shapes. More...

#include <EigenModeSIM.h>

Inheritance diagram for EigenModeSIM:

[legend]

Collaboration diagram for EigenModeSIM:

[legend]

Public Member Functions
	EigenModeSIM (SIMbase &sim)
	The constructor initializes the FE model reference.

virtual	~EigenModeSIM ()
	Empty destructor.

virtual bool	parse (const tinyxml2::XMLElement *elem)
	Parses a data section from an XML document.

virtual void	printProblem (bool stopInputTimer=false) const
	Prints out problem-specific data to the log stream.

virtual void	initSol (size_t nSol, size_t nDof)
	Initializes primary solution vectors.

virtual bool	advanceStep (TimeStep &param, bool updateTime=true)
	Advances the time step one step forward.

virtual SIM::ConvStatus	solveStep (TimeStep &param, SIM::SolutionMode, double zero_tolerance, std::streamsize outPrec)
	Computes the primary solution at current time step. More...

virtual bool	parse (const tinyxml2::XMLElement *elem)
	Parses a data section from an XML document. More...

Public Member Functions inherited from MultiStepSIM
virtual const char **	getPrioritizedTags () const
	Returns a list of prioritized XML-tags.

virtual void	initPrm ()
	Initializes time integration parameters for the integrand.

bool	initEqSystem (bool withRF=true, size_t nScl=0)
	Allocates the FE system matrices. More...

virtual bool	preprocess (const std::vector< int > &ignored, bool fixDup)
	Performs some pre-processing tasks on the FE model. More...

void	setStartGeo (int gID)
	Initializes the geometry block counter.

bool	saveModel (const char *fileName)
	Opens a new VTF-file and writes the model geometry to it. More...

bool	saveModel (int &gBlock, int &rBlock, const char *fileName=nullptr, bool clearG=true)
	Opens a new VTF-file and writes the model geometry to it. More...

bool	saveModel (int &gBlock, int &rBlock, double time)
	Writes the model geometry and BCs to an already opened VTF-file. More...

bool	saveStep (int iStep, double time, const char *vecName=nullptr)
	Saves the converged solution to VTF file of a given time/load step. More...

bool	saveStep (int iStep, int &rBlock, double time, const char *vecName=nullptr)
	Saves the converged solution to VTF file of a given time/load step. More...

bool	saveStep (int iStep, int &rBlock, const char *vecName)
	Saves the converged solution to VTF file of a given time/load step. More...

virtual bool	serialize (SerializeMap &data) const
	Serializes the solution vectors for restarting purposes. More...

virtual bool	deSerialize (const SerializeMap &data)
	Restores the solution vectors from a serialized state. More...

bool	checkForRestart ()
	Restores the solution from a serialized state in case of restart.

void	dumpStep (int iStep, double time, utl::LogStream &os, bool withID=true) const
	Dumps the primary solution for inspection. More...

virtual void	dumpResults (double time, utl::LogStream &os, std::streamsize precision=3, bool formatted=true) const
	Dumps solution variables at user-defined points. More...

bool	hasPointResultFile () const
	Returns whether a points result file has been defined or not.

bool	savePoints (double time, int step) const
	Saves point-wise solution to file for a given time/load step. More...

virtual bool	isLinear () const
	Returns whether this solution driver is linear or not.

virtual bool	isDynamic () const
	Returns whether this is a dynamic solution driver or not.

const SIMoutput &	getModel () const
	Returns a const reference to the FE model.

void	setSubIteration (SubIt flag)
	Updates the sub-iteration flag.

SubIt	getSubIteration () const
	Returns the sub-iteration flag.

virtual size_t	numSolution () const
	Returns the number of solution vectors.

virtual const Vector &	realSolution (int i=0) const
	Returns a const reference to the current real solution vector. More...

virtual const Vectors &	realSolutions (bool=false)
	Returns a const reference to the current real solution vectors. More...

double *	theRefNorm ()
	Returns a pointer to the reference norm variable.

const double *	getRefNorm () const
	Returns a const pointer to the reference norm variable.

virtual bool	parse (char *keyWord, std::istream &is)
	Parses a data section from an input stream.

virtual bool	parse (const tinyxml2::XMLElement *elem)
	Parses a data section from an XML document.

Public Member Functions inherited from SIMsolution
virtual const Vectors &	getSolutions () const
	Returns a const reference to the solution vectors.

virtual Vectors &	theSolutions ()
	Returns a reference to the solution vectors (for assignment).

virtual const Vector &	getSolution (int ix=0) const
	Returns a const reference to current solution vector.

virtual void	setSolution (const RealArray &s, int ix=0)
	Modifies the current solution vector (used by sub-iterations only).

Public Member Functions inherited from SIMadmin
virtual	~SIMadmin ()
	Empty destructor.

virtual bool	read (const char *fileName)
	Reads model data from the specified input file *fileName.

virtual bool	parse (char *keyWord, std::istream &is)
	Parses a data section from an input stream.

virtual bool	preprocessC (const IntVec &, bool, double=0.0)
	Performs some pre-processing tasks on the FE model.

const ProcessAdm &	getProcessAdm () const
	Returns the parallel process administrator.

int	getGlobalProcessID () const
	Returns the global process ID. More...

const std::string &	getHeading () const
	Returns the simulator heading.

void	setHeading (const std::string &heading)
	Defines the simulator heading.

void	printHeading (int &supStep) const
	Prints the heading of this simulator, if any, to IFEM::cout.

Public Member Functions inherited from XMLInputBase
bool	readXML (const char *fileName, bool verbose=true)
	Reads an XML input file. More...

bool	loadXML (const char *xml)
	Loads data from an XML-formatted text string. More...

Private Attributes
double	myStart
	The start time of this simulator.

std::vector< Mode >	modes
	Eigenmode shapes and frequencies.

std::vector< double >	amplitude
	Eigenmode shape amplitudes.

std::vector< double >	omega
	Applied angular frequencies.

Additional Inherited Members
Public Types inherited from MultiStepSIM
enum	SubIt { ITER = 0 , FIRST = 1 , LAST = 2 , NONE = 3 }
	Enum describing sub-iteration status.

Public Attributes inherited from SIMadmin
SIMoptions &	opt
	Simulation control parameters.

Static Public Attributes inherited from SIMadmin
static int	msgLevel = 2
	Controls the console output amount during solving.

Protected Types inherited from MultiStepSIM
enum	NormOp { MAX , ALL }
	Enum describing reference norm options.

Protected Types inherited from SIMsolution
using	SerializeMap = std::map< std::string, std::string >
	Convenience type.

Protected Types inherited from SIMadmin
using	IntVec = std::vector< int >
	Convenience alias.

Protected Member Functions inherited from MultiStepSIM
	MultiStepSIM (SIMbase &sim)
	The constructor initializes the FE model reference. More...

void	printStep (const TimeStep &param) const
	Prints out time/load step identification. More...

virtual bool	solutionNorms (const TimeDomain &, double zero_tolerance=1.0e-8, std::streamsize outPrec=0)
	Computes and prints some solution norm quantities. More...

int	getLastSavedStep () const
	Returns the last step that was saved to VTF.

Protected Member Functions inherited from SIMsolution
	SIMsolution ()=default
	The default constructor is protected to allow sub-classes only.

virtual	~SIMsolution ()=default
	Empty default destructor.

void	initSolution (size_t ndof, size_t nsol=1)
	Initializes the solution vectors. More...

void	pushSolution (unsigned short int nVecState=1)
	Pushes the solution vector stack. More...

bool	saveSolution (SerializeMap &data, const std::string &name) const
	Writes current solution to a serialization container. More...

bool	restoreSolution (const SerializeMap &data, const std::string &name)
	Restores the solution from a serialization container. More...

Protected Member Functions inherited from SIMadmin
	SIMadmin (const char *heading=nullptr)
	The default constructor initializes the process administrator.

	SIMadmin (SIMadmin &anotherSIM)
	Copy constructor.

Protected Member Functions inherited from XMLInputBase
const tinyxml2::XMLElement *	loadFile (tinyxml2::XMLDocument &doc, const char *fileName, bool verbose=false)
	Loads an XML input file into a tinyxml2::XMLDocument object. More...

Static Protected Member Functions inherited from SIMsolution
static std::string	serialize (const double *v, size_t n)
	Helper method for serializing a double array into a text string. More...

static void	deSerialize (const std::string &data, double *v, size_t n)
	Helper method for deserializing a double array from a text string. More...

Protected Attributes inherited from MultiStepSIM
SIMoutput &	model
	The isogeometric FE model.

Vector	loadVec
	System load vector (for output to VTF)

Vector	residual
	Residual force vector.

Vector	linsol
	Linear solution vector.

NormOp	refNopt
	Reference norm option.

double	refNorm
	Reference norm value used in convergence checks.

double	rCond
	Reciprocal condition number of the linear equation system.

SubIt	subiter
	Sub-iteration flag.

size_t	nRHSvec
	Number of right-hand-side vectors to assemble.

char	rotUpd
	Option for how to update of nodal rotations.

int	geoBlk
	Running VTF geometry block counter.

int	nBlock
	Running VTF result block counter.

Protected Attributes inherited from SIMsolution
Vectors	solution
	Stack of solution vectors.

Protected Attributes inherited from SIMadmin
ProcessAdm	adm
	Parallel administrator.

int	myPid
	Processor ID in parallel simulations.

int	nProc
	Number of processors in parallel simulations.

std::string	myHeading
	Heading written before reading the input file.

Detailed Description

Driver for computing a time history from a set of eigen mode shapes.

Member Function Documentation

◆ parse()

bool MultiStepSIM::parse

Parses a data section from an XML document.

Parameters

[in] elem The XML element to parse

◆ solveStep()

SIM::ConvStatus EigenModeSIM::solveStep	(	TimeStep &	param,
		SIM::SolutionMode	,
		double	zero_tolerance,
		std::streamsize	outPrec
	)

virtual

Computes the primary solution at current time step.

Parameters

	param	Time stepping parameters
[in]	zero_tolerance	Truncate norm values smaller than this to zero
[in]	outPrec	Number of digits after the decimal point in norm print

Implements MultiStepSIM.

References amplitude, TimeDomain::dt, epsZ, modes, SIMadmin::msgLevel, myStart, MultiStepSIM::printStep(), SIMsolution::solution, MultiStepSIM::solutionNorms(), TimeDomain::t, and TimeStep::time.

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

src/SIM/EigenModeSIM.h
src/SIM/EigenModeSIM.C

Public Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ parse()

◆ solveStep()