Newmark-based solution driver for dynamic isogeometric FEM simulators. More...

#include <NewmarkSIM.h>

Inheritance diagram for NewmarkSIM:

[legend]

Collaboration diagram for NewmarkSIM:

[legend]

Public Member Functions
	NewmarkSIM (SIMbase &sim)
	The constructor initializes default solution parameters.

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

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

bool	initAcc (double zero_tolerance=1.0e-8, std::streamsize outPrec=0)
	Calculates initial accelerations.

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

virtual SIM::ConvStatus	solveStep (TimeStep &param, SIM::SolutionMode=SIM::STATIC, double zero_tolerance=1.0e-8, std::streamsize outPrec=0)
	Solves the dynamic equations by a predictor/multi-corrector method. More...

SIM::ConvStatus	solveIteration (TimeStep &param)
	Solves the linearized system of current iteration. More...

int	getMaxit () const
	Returns the maximum number of iterations.

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

const Vector &	getVelocity () const
	Returns a const reference to current velocity vector.

const Vector &	getAcceleration () const
	Returns a const reference to current velocity vector.

bool	saveStep (int iStep, TimeStep &param)
	Saves the converged solution to VTF file for a given time step. 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...

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

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.

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

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

virtual void	initSol (size_t nSol=1, size_t nDof=0)
	Initializes the primary solution vectors. More...

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

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.

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

Static Public Attributes
static const char *	inputContext = "newmarksolver"
	Input file context for solver parameters.

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

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

virtual SIM::ConvStatus	checkConvergence (TimeStep &param)
	Checks whether the corrector iterations have converged or diverged.

virtual bool	predictStep (TimeStep &param)
	Calculates predicted velocities and accelerations.

virtual bool	correctStep (TimeStep &param, bool=false)
	Updates configuration variables (solution vector) in an iteration.

virtual void	finalizeRHSvector (bool)
	Finalizes the right-hand-side vector on the system level.

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

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

Protected Attributes
double	alpha1
	Mass-proportional damping parameter.

double	alpha2
	Stiffness-proportional damping parameter.

double	beta
	Newmark time integration parameter.

double	gamma
	Newmark time integration parameter.

bool	solveDisp
	If true, use incremental displacements as unknowns.

char	predictor
	Predictor type flag.

int	maxit
	Maximum number of iterations in a time step.

int	maxIncr
	Maximum number of iterations with increasing norm.

int	nupdat
	Number of iterations with updated tangent.

int	saveIts
	Time step for which iteration result should be saved.

char	saveVelAc
	Flag the saving of velocity and acceleration to VTF.

double	rTol
	Relative convergence tolerance.

double	aTol
	Absolute convergence tolerance.

double	divgLim
	Relative divergence limit.

unsigned short int	cNorm
	Option for which convergence norm to use.

std::string	factor_file
	File for storage of factorized Newton matrix.

bool	write_factor
	If true, write new factorized Newton matrix.

bool	read_factor
	If true, read factorized Newton matrix.

LinAlg::StorageFormat	fmt
	Factorized Newton matrix storage format.

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.

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.

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.

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

Detailed Description

Newmark-based solution driver for dynamic isogeometric FEM simulators.

Member Function Documentation

◆ dumpResults()

void NewmarkSIM::dumpResults	(	double	time,
		utl::LogStream &	os,
		std::streamsize	precision = `3`,
		bool	formatted = `true`
	)		const

virtual

Dumps solution variables at user-defined points.

Parameters

[in]	time	Current time
[in]	os	The output stream to write the solution to
[in]	precision	Number of digits after the decimal point
[in]	formatted	If false, write all result points on a single line

Reimplemented from MultiStepSIM.

References SIMoutput::dumpMoreResults(), SIMoutput::dumpResults(), SIMoutput::dumpVector(), getAcceleration(), getVelocity(), MultiStepSIM::model, and MultiStepSIM::realSolution().

◆ parse()

bool MultiStepSIM::parse

Parses a data section from an XML document.

Parameters

[in] elem The XML element to parse

Referenced by GenAlphaSIM::parse(), HHTSIM::parse(), and NewmarkNLSIM::parse().

◆ printProblem()

void NewmarkSIM::printProblem ( bool stopInputTimer = false ) const

virtual

Prints out problem-specific data to the log stream.

Parameters

[in] stopInputTimer If true, stop file input timer before print

Reimplemented from MultiStepSIM.

Reimplemented in NewmarkNLSIM, and HHTSIM.

References alpha1, alpha2, beta, IFEM::cout, gamma, nupdat, predictor, MultiStepSIM::printProblem(), and solveDisp.

Referenced by HHTSIM::printProblem(), and NewmarkNLSIM::printProblem().

◆ saveStep() [1/4]

bool MultiStepSIM::saveStep

Saves the converged solution to VTF file of a given time/load step.

Parameters

[in]	iStep	Time/load step identifier
[in]	time	Current time/load parameter
[in]	vecName	Optional name of primary solution vector field

Referenced by saveStep(), and solveStep().

◆ saveStep() [2/4]

bool MultiStepSIM::saveStep

Saves the converged solution to VTF file of a given time/load step.

Parameters

[in]	iStep	Time/load step identifier
	rBlock	Running result block counter
[in]	vecName	Name of primary solution vector field

This method only writes the primary solution vector as a vector field. It is mainly used when this simulator is a component in a coupled simulation, and where the secondary solution is of minor interest.

◆ saveStep() [3/4]

bool MultiStepSIM::saveStep

Saves the converged solution to VTF file of a given time/load step.

Parameters

[in]	iStep	Time/load step identifier
	rBlock	Running result block counter
[in]	time	Current time/load parameter
[in]	vecName	Optional name of primary solution vector field

Use this method when other simulators write results to the same VTF-file. The internal result block counter nBlock is syncronized with the argument rBlock before the results of this simulator are written, to avoid that multiple result blocks receive the same result block ID.

◆ saveStep() [4/4]

bool NewmarkSIM::saveStep	(	int	iStep,
		TimeStep &	param
	)

Saves the converged solution to VTF file for a given time step.

Parameters

[in]	iStep	Time step identifier
[in]	param	Time stepping parameters

References SIMbase::getNoFields(), MultiStepSIM::model, MultiStepSIM::nBlock, MultiStepSIM::numSolution(), saveStep(), saveVelAc, TimeDomain::t, TimeStep::time, and SIMoutput::writeGlvS1().

◆ solutionNorms()

bool NewmarkSIM::solutionNorms	(	const TimeDomain &	,
		double	zero_tolerance = `1.0e-8`,
		std::streamsize	outPrec = `0`
	)

protectedvirtual

Computes and prints some solution norm quantities.

Parameters

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

Reimplemented from MultiStepSIM.

References ProcessAdm::cout, SIMbase::getNoFields(), SIMadmin::getProcessAdm(), MultiStepSIM::model, SIMadmin::msgLevel, utl::LogStream::precision(), MultiStepSIM::realSolutions(), SIMbase::solutionNorms(), utl::trunc(), and utl::zero_print_tol.

Referenced by solveIteration(), and solveStep().

◆ solveIteration()

SIM::ConvStatus NewmarkSIM::solveIteration ( TimeStep & param )

Solves the linearized system of current iteration.

Parameters

[in] param Time stepping parameters

References SIMbase::assembleSystem(), checkConvergence(), correctStep(), SIMbase::extractLoadVec(), finalizeRHSvector(), TimeDomain::first, TimeStep::iter, MultiStepSIM::linsol, MultiStepSIM::model, SIMadmin::msgLevel, nupdat, predictStep(), MultiStepSIM::rCond, MultiStepSIM::residual, SIMbase::setMode(), SIMsolution::solution, solutionNorms(), SIMbase::solveEqSystem(), TimeDomain::t, TimeStep::time, and SIMbase::updateDirichlet().

◆ solveStep()

SIM::ConvStatus NewmarkSIM::solveStep	(	TimeStep &	param,
		SIM::SolutionMode	= `SIM::STATIC`,
		double	zero_tolerance = `1.0e-8`,
		std::streamsize	outPrec = `0`
	)

virtual

Solves the dynamic equations by a predictor/multi-corrector method.

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 SIMbase::assembleSystem(), LinAlg::BINARY, checkConvergence(), correctStep(), IFEM::cout, ProcessAdm::cout, TimeDomain::dt, SystemMatrix::dump(), SIMbase::dumpSolVec(), SIMbase::extractLoadVec(), factor_file, finalizeRHSvector(), TimeDomain::first, fmt, MultiStepSIM::getLastSavedStep(), SIMbase::getLHSmatrix(), SIMadmin::getProcessAdm(), TimeStep::iter, MultiStepSIM::linsol, SystemMatrix::load(), MultiStepSIM::loadVec, maxit, MultiStepSIM::model, SIMadmin::msgLevel, SIMoptions::nGauss, MultiStepSIM::nRHSvec, nupdat, SIMadmin::opt, predictStep(), MultiStepSIM::printStep(), PROFILE1, MultiStepSIM::rCond, read_factor, MultiStepSIM::residual, saveIts, saveStep(), SIMbase::setMode(), SIMbase::setQuadratureRule(), SIMsolution::solution, solutionNorms(), SIMbase::solveEqSystem(), SIMbase::solveSystem(), TimeStep::step, MultiStepSIM::subiter, TimeDomain::t, TimeStep::time, SIMbase::updateDirichlet(), and write_factor.

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

src/SIM/NewmarkSIM.h
src/SIM/NewmarkSIM.C

Public Member Functions

Static Public Attributes

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ dumpResults()

◆ parse()

◆ printProblem()

◆ saveStep() [1/4]

◆ saveStep() [2/4]

◆ saveStep() [3/4]

◆ saveStep() [4/4]

◆ solutionNorms()

◆ solveIteration()

◆ solveStep()