GEOS
Classes | Public Types | Public Member Functions | Static Public Member Functions | Public Attributes | Protected Member Functions | List of all members
geos::ElasticWaveEquationSEM Class Reference
Inheritance diagram for geos::ElasticWaveEquationSEM:
Inheritance graph
[legend]

Classes

struct  viewKeyStruct
 

Public Types

using EXEC_POLICY = parallelDevicePolicy< >
 
using ATOMIC_POLICY = parallelDeviceAtomic
 
- Public Types inherited from geos::WaveSolverBase
using EXEC_POLICY = WaveSolverUtils::EXEC_POLICY
 
using wsCoordType = WaveSolverUtils::wsCoordType
 
- Public Types inherited from geos::PhysicsSolverBase
using CatalogInterface = dataRepository::CatalogInterface< PhysicsSolverBase, string const &, Group *const >
 Type alias for catalog interface used by this class. See CatalogInterface.
 
- Public Types inherited from geos::ExecutableGroup
enum class  TimesteppingBehavior : integer { DeterminesTimeStepSize , DoesNotDetermineTimeStepSize }
 Timestepping type. More...
 
- Public Types inherited from geos::dataRepository::Group
using subGroupMap = MappedVector< Group, Group *, keyType, indexType >
 The template specialization of MappedVector to use for the collection of sub-Group objects.
 
using wrapperMap = MappedVector< WrapperBase, WrapperBase *, keyType, indexType >
 The template specialization of MappedVector to use for the collection wrappers objects.
 
using CatalogInterface = dataRepository::CatalogInterface< Group, string const &, Group *const >
 Type alias for catalog interface used by this class. See CatalogInterface.
 

Public Member Functions

 ElasticWaveEquationSEM (const std::string &name, Group *const parent)
 
 ElasticWaveEquationSEM (ElasticWaveEquationSEM const &)=delete
 
 ElasticWaveEquationSEM (ElasticWaveEquationSEM &&)=default
 
ElasticWaveEquationSEMoperator= (ElasticWaveEquationSEM const &)=delete
 
ElasticWaveEquationSEMoperator= (ElasticWaveEquationSEM &&)=delete
 
string getCatalogName () const override
 
virtual void initializePreSubGroups () override
 Called by Initialize() prior to initializing sub-Groups.
 
virtual void registerDataOnMesh (Group &meshBodies) override final
 Register wrappers that contain data on the mesh objects. More...
 
virtual real64 explicitStepForward (real64 const &time_n, real64 const &dt, integer const cycleNumber, DomainPartition &domain, bool const computeGradient) override
 Perform forward explicit step. More...
 
virtual real64 explicitStepBackward (real64 const &time_n, real64 const &dt, integer const cycleNumber, DomainPartition &domain, bool const computeGradient) override
 Perform backward explicit step. More...
 
void addSourceToRightHandSide (real64 const &time_n, arrayView1d< real32 > const rhsx, arrayView1d< real32 > const rhsy, arrayView1d< real32 > const rhsz)
 Multiply the precomputed term by the Ricker and add to the right-hand side. More...
 
void computeDAS (arrayView2d< real32 > const xCompRcv, arrayView2d< real32 > const yCompRcv, arrayView2d< real32 > const zCompRcv)
 Compute DAS data as a difference of the field at two points, from the appropriate three-component receiver pairs, when the DAS type is set to 2. More...
 
virtual real64 computeTimeStep (real64 &dtOut) override
 
virtual void cleanup (real64 const time_n, integer const cycleNumber, integer const eventCounter, real64 const eventProgress, DomainPartition &domain) override
 Overridden from ExecutableGroup. Used to write last seismogram if needed.
 
real64 explicitStepInternal (real64 const &time_n, real64 const &dt, DomainPartition &domain)
 
void computeUnknowns (real64 const &time_n, real64 const &dt, DomainPartition &domain, MeshLevel &mesh, arrayView1d< string const > const &regionNames)
 
void synchronizeUnknowns (real64 const &time_n, real64 const &dt, DomainPartition &domain, MeshLevel &mesh, arrayView1d< string const > const &regionNames)
 
void prepareNextTimestep (MeshLevel &mesh)
 
real32 computeGlobalMinQFactor ()
 Computes the minimum attenuation quality factor over all the mesh. This is useful for computing anelasticity coefficients, which are usually global parameters.
 
- Public Member Functions inherited from geos::WaveSolverBase
 WaveSolverBase (const std::string &name, Group *const parent)
 
 WaveSolverBase (WaveSolverBase const &)=delete
 
 WaveSolverBase (WaveSolverBase &&)=default
 
WaveSolverBaseoperator= (WaveSolverBase const &)=delete
 
WaveSolverBaseoperator= (WaveSolverBase &&)=delete
 
virtual real64 solverStep (real64 const &time_n, real64 const &dt, integer const cycleNumber, DomainPartition &domain) override
 entry function to perform a solver step More...
 
virtual real64 explicitStep (real64 const &time_n, real64 const &dt, integer const cycleNumber, DomainPartition &domain) override
 Entry function for an explicit time integration step. More...
 
void reinit () override final
 Re-initialize source and receivers positions in the mesh, and resize the pressureNp1_at_receivers array.
 
SortedArray< localIndex > const & getSolverNodesSet ()
 
void computeTargetNodeSet (arrayView2d< localIndex const, cells::NODE_MAP_USD > const &elemsToNodes, localIndex const subRegionSize, localIndex const numQuadraturePointsPerElem)
 
- Public Member Functions inherited from geos::PhysicsSolverBase
 PhysicsSolverBase (string const &name, Group *const parent)
 Constructor for PhysicsSolverBase. More...
 
 PhysicsSolverBase (PhysicsSolverBase &&)=default
 Move constructor for PhysicsSolverBase.
 
virtual ~PhysicsSolverBase () override
 Destructor for PhysicsSolverBase.
 
 PhysicsSolverBase ()=delete
 Deleted constructor.
 
 PhysicsSolverBase (PhysicsSolverBase const &)=delete
 Deleted copy constructor.
 
PhysicsSolverBaseoperator= (PhysicsSolverBase const &)=delete
 Deleted copy assignment operator.
 
PhysicsSolverBaseoperator= (PhysicsSolverBase &&)=delete
 Deleted move assignment operator.
 
virtual void initialize_postMeshGeneration () override
 Initialization tasks after mesh generation is completed.
 
void generateMeshTargetsFromTargetRegions (Group const &meshBodies)
 Generate mesh targets from target regions. More...
 
virtual bool execute (real64 const time_n, real64 const dt, integer const cycleNumber, integer const eventCounter, real64 const eventProgress, DomainPartition &domain) override
 Main extension point of executable targets. More...
 
ParallelMatrixgetSystemMatrix ()
 Getter for system matrix. More...
 
ParallelMatrix const & getSystemMatrix () const
 Getter for system rhs vector. More...
 
ParallelVectorgetSystemRhs ()
 Getter for system rhs vector. More...
 
ParallelVector const & getSystemRhs () const
 Getter for system rhs vector. More...
 
ParallelVectorgetSystemSolution ()
 Getter for system solution vector. More...
 
ParallelVector const & getSystemSolution () const
 Getter for system solution vector. More...
 
DofManagergetDofManager ()
 Getter for degree-of-freedom manager. More...
 
DofManager const & getDofManager () const
 Getter for degree-of-freedom manager. More...
 
CRSMatrix< real64, globalIndex > & getLocalMatrix ()
 Getter for local matrix. More...
 
CRSMatrixView< real64 const, globalIndex const > getLocalMatrix () const
 Getter for local matrix. More...
 
virtual real64 setNextDt (real64 const &currentDt, DomainPartition &domain)
 function to set the next time step size More...
 
virtual real64 setNextDtBasedOnNewtonIter (real64 const &currentDt)
 function to set the next time step size based on Newton convergence More...
 
virtual real64 setNextDtBasedOnStateChange (real64 const &currentDt, DomainPartition &domain)
 function to set the next dt based on state change More...
 
virtual real64 setNextDtBasedOnCFL (real64 const &currentDt, DomainPartition &domain)
 function to set the next dt based on state change More...
 
virtual real64 nonlinearImplicitStep (real64 const &time_n, real64 const &dt, integer const cycleNumber, DomainPartition &domain)
 Function for a nonlinear implicit integration step. More...
 
virtual bool lineSearch (real64 const &time_n, real64 const &dt, integer const cycleNumber, DomainPartition &domain, DofManager const &dofManager, CRSMatrixView< real64, globalIndex const > const &localMatrix, ParallelVector &rhs, ParallelVector &solution, real64 const scaleFactor, real64 &lastResidual)
 Function to perform line search. More...
 
virtual bool lineSearchWithParabolicInterpolation (real64 const &time_n, real64 const &dt, integer const cycleNumber, DomainPartition &domain, DofManager const &dofManager, CRSMatrixView< real64, globalIndex const > const &localMatrix, ParallelVector &rhs, ParallelVector &solution, real64 const scaleFactor, real64 &lastResidual, real64 &residualNormT)
 Function to perform line search using a parabolic interpolation to find the scaling factor. More...
 
virtual real64 linearImplicitStep (real64 const &time_n, real64 const &dt, integer const cycleNumber, DomainPartition &domain)
 Function for a linear implicit integration step. More...
 
virtual void implicitStepSetup (real64 const &time_n, real64 const &dt, DomainPartition &domain)
 function to perform setup for implicit timestep More...
 
virtual void setupDofs (DomainPartition const &domain, DofManager &dofManager) const
 Populate degree-of-freedom manager with fields relevant to this solver. More...
 
virtual void setupSystem (DomainPartition &domain, DofManager &dofManager, CRSMatrix< real64, globalIndex > &localMatrix, ParallelVector &rhs, ParallelVector &solution, bool const setSparsity=true)
 Set up the linear system (DOF indices and sparsity patterns) More...
 
virtual void assembleSystem (real64 const time, real64 const dt, DomainPartition &domain, DofManager const &dofManager, CRSMatrixView< real64, globalIndex const > const &localMatrix, arrayView1d< real64 > const &localRhs)
 function to assemble the linear system matrix and rhs More...
 
virtual void applyBoundaryConditions (real64 const time, real64 const dt, DomainPartition &domain, DofManager const &dofManager, CRSMatrixView< real64, globalIndex const > const &localMatrix, arrayView1d< real64 > const &localRhs)
 apply boundary condition to system More...
 
void debugOutputSystem (real64 const &time, integer const cycleNumber, integer const nonlinearIteration, ParallelMatrix const &matrix, ParallelVector const &rhs) const
 Output the assembled linear system for debug purposes. More...
 
void debugOutputSolution (real64 const &time, integer const cycleNumber, integer const nonlinearIteration, ParallelVector const &solution) const
 Output the linear system solution for debug purposes. More...
 
virtual real64 calculateResidualNorm (real64 const &time, real64 const &dt, DomainPartition const &domain, DofManager const &dofManager, arrayView1d< real64 const > const &localRhs)
 calculate the norm of the global system residual More...
 
virtual void solveLinearSystem (DofManager const &dofManager, ParallelMatrix &matrix, ParallelVector &rhs, ParallelVector &solution)
 function to apply a linear system solver to the assembled system. More...
 
virtual bool checkSystemSolution (DomainPartition &domain, DofManager const &dofManager, arrayView1d< real64 const > const &localSolution, real64 const scalingFactor)
 Function to check system solution for physical consistency and constraint violation. More...
 
virtual real64 scalingForSystemSolution (DomainPartition &domain, DofManager const &dofManager, arrayView1d< real64 const > const &localSolution)
 Function to determine if the solution vector should be scaled back in order to maintain a known constraint. More...
 
virtual void applySystemSolution (DofManager const &dofManager, arrayView1d< real64 const > const &localSolution, real64 const scalingFactor, real64 const dt, DomainPartition &domain)
 Function to apply the solution vector to the state. More...
 
virtual bool updateConfiguration (DomainPartition &domain)
 updates the configuration (if needed) based on the state after a converged Newton loop. More...
 
virtual void outputConfigurationStatistics (DomainPartition const &domain) const
 
virtual void resetConfigurationToBeginningOfStep (DomainPartition &domain)
 resets the configuration to the beginning of the time-step. More...
 
virtual bool resetConfigurationToDefault (DomainPartition &domain) const
 resets the configuration to the default value. More...
 
virtual void updateState (DomainPartition &domain)
 Recompute all dependent quantities from primary variables (including constitutive models) More...
 
virtual void resetStateToBeginningOfStep (DomainPartition &domain)
 reset state of physics back to the beginning of the step. More...
 
virtual void implicitStepComplete (real64 const &time, real64 const &dt, DomainPartition &domain)
 perform cleanup for implicit timestep More...
 
virtual real64 getTimestepRequest (real64 const) override
 getter for the next timestep size More...
 
real64 getTimestepRequest ()
 getter for the next timestep size More...
 
virtual GroupcreateChild (string const &childKey, string const &childName) override
 creates a child group of of this PhysicsSolverBase instantiation More...
 
Timestamp getSystemSetupTimestamp () const
 getter for the timestamp of the system setup More...
 
Timestamp getMeshModificationTimestamp (DomainPartition &domain) const
 getter for the timestamp of the mesh modification on the mesh levels More...
 
void setSystemSetupTimestamp (Timestamp timestamp)
 set the timestamp of the system setup More...
 
R1Tensor const gravityVector () const
 return the value of the gravity vector specified in PhysicsSolverManager More...
 
virtual bool checkSequentialSolutionIncrements (DomainPartition &domain) const
 Check if the solution increments are ok to use. More...
 
virtual void saveSequentialIterationState (DomainPartition &domain)
 Save the state of the solver for sequential iteration. More...
 
LinearSolverParametersgetLinearSolverParameters ()
 accessor for the linear solver parameters. More...
 
LinearSolverParameters const & getLinearSolverParameters () const
 const accessor for the linear solver parameters. More...
 
NonlinearSolverParametersgetNonlinearSolverParameters ()
 accessor for the nonlinear solver parameters. More...
 
NonlinearSolverParameters const & getNonlinearSolverParameters () const
 const accessor for the nonlinear solver parameters. More...
 
virtual void synchronizeNonlinearSolverParameters ()
 syncronize the nonlinear solver parameters.
 
localIndex targetRegionIndex (string const &regionName) const
 Get position of a given region within solver's target region list. More...
 
template<typename LAMBDA >
void forDiscretizationOnMeshTargets (Group const &meshBodies, LAMBDA &&lambda) const
 Loop over the target discretization on all mesh targets and apply callback. More...
 
template<typename LAMBDA >
void forDiscretizationOnMeshTargets (Group &meshBodies, LAMBDA &&lambda) const
 Loop over the target discretization on all mesh targets and apply callback. More...
 
string getDiscretizationName () const
 return the name of the discretization object More...
 
virtual bool registerCallback (void *func, const std::type_info &funcType) final override
 function to set the value of m_assemblyCallback More...
 
SolverStatisticsgetSolverStatistics ()
 accessor for the solver statistics. More...
 
SolverStatistics const & getSolverStatistics () const
 const accessor for the solver statistics. More...
 
map< std::pair< string, string >, array1d< string > > const & getMeshTargets () const
 accessor for m_meshTargets More...
 
- Public Member Functions inherited from geos::ExecutableGroup
virtual void signalToPrepareForExecution (real64 const time_n, real64 const dt, integer const cycle, DomainPartition &domain)
 Inform the object that it expects to execute during the next timestep. More...
 
void setTimesteppingBehavior (TimesteppingBehavior const timesteppingBehavior)
 Set the timestep behavior for a target. More...
 
TimesteppingBehavior getTimesteppingBehavior () const
 Get the target's time step behavior. More...
 
- Public Member Functions inherited from geos::dataRepository::Group
template<typename LOG_LEVEL_INFO >
std::enable_if_t< geos::is_log_level_info< LOG_LEVEL_INFO >, void > addLogLevel ()
 Append a levelCondition and a log description to the description of the wrapped object given a log info struct. Must be called in constructor. More...
 
 Group (string const &name, Group *const parent)
 Constructor. More...
 
 Group (string const &name, conduit::Node &rootNode)
 Constructor. More...
 
 Group (Group &&source)=default
 Move constructor. More...
 
virtual ~Group ()
 Destructor, deletes all Groups and Wrappers owned by this Group.
 
 Group ()=delete
 Deleted default constructor.
 
 Group (Group const &)=delete
 Deleted copy constructor.
 
Groupoperator= (Group const &)=delete
 Deleted copy assignment operator. More...
 
Groupoperator= (Group &&)=delete
 Deleted move assignment operator. More...
 
void printDataHierarchy (integer indent=0) const
 Prints the data hierarchy recursively. More...
 
string dumpInputOptions () const
 
string dumpSubGroupsNames () const
 
string dumpWrappersNames () const
 
template<typename T = Group>
T & registerGroup (string const &name, std::unique_ptr< T > newObject)
 Register a new Group as a sub-group of current Group. More...
 
template<typename T = Group>
T & registerGroup (string const &name, T *newObject)
 Register a new Group as a sub-group of current Group. More...
 
template<typename T = Group>
T & registerGroup (string const &name)
 Register a new Group as a sub-group of current Group. More...
 
template<typename T = Group>
T & registerGroup (subGroupMap::KeyIndex const &keyIndex)
 Register a new Group as a sub-group of current Group. More...
 
template<typename T = Group, typename TBASE = Group>
T & registerGroup (string const &name, string const &catalogName)
 Register a new Group as a sub-group of current Group. More...
 
void deregisterGroup (string const &name)
 Removes a child group from this group. More...
 
template<typename T = Group, typename KEY = void>
T * getGroupPointer (KEY const &key)
 Return a pointer to a sub-group of the current Group. More...
 
template<typename T = Group, typename KEY = void>
T const * getGroupPointer (KEY const &key) const
 Return a pointer to a sub-group of the current Group. More...
 
template<typename T = Group, typename KEY = void>
T & getGroup (KEY const &key)
 Return a reference to a sub-group of the current Group. More...
 
template<typename T = Group, typename KEY = void>
T const & getGroup (KEY const &key) const
 Return a reference to a sub-group of the current Group. More...
 
template<typename T = Group>
T & getGroupByPath (string const &path)
 Retrieve a group from the hierarchy using a path. More...
 
template<typename T = Group>
T const & getGroupByPath (string const &path) const
 Retrieve a group from the hierarchy using a path. More...
 
subGroupMapgetSubGroups ()
 Get the subgroups object. More...
 
subGroupMap const & getSubGroups () const
 Get the subgroups object. More...
 
localIndex numSubGroups () const
 return the number of sub groups in this Group More...
 
std::vector< stringgetSubGroupsNames () const
 
template<typename T = Group>
bool hasGroup (string const &name) const
 Check whether a sub-group exists. More...
 
template<typename T >
bool hasSubGroupOfType () const
 Check whether a sub-group exists by type. More...
 
template<typename GROUPTYPE = Group, typename ... GROUPTYPES, typename LAMBDA >
void forSubGroups (LAMBDA &&lambda)
 Apply the given functor to subgroups that can be casted to one of specified types. More...
 
template<typename GROUPTYPE = Group, typename ... GROUPTYPES, typename LAMBDA >
void forSubGroups (LAMBDA &&lambda) const
 Apply the given functor to subgroups that can be casted to one of specified types. More...
 
template<typename GROUPTYPE = Group, typename ... GROUPTYPES, typename LAMBDA >
void forSubGroupsIndex (LAMBDA &&lambda)
 Apply the given functor to subgroups that can be casted to one of specified types. More...
 
template<typename GROUPTYPE = Group, typename ... GROUPTYPES, typename LAMBDA >
void forSubGroupsIndex (LAMBDA &&lambda) const
 Apply the given functor to subgroups that can be casted to one of specified types. More...
 
template<typename GROUPTYPE = Group, typename ... GROUPTYPES, typename LOOKUP_CONTAINER , typename LAMBDA >
void forSubGroups (LOOKUP_CONTAINER const &subGroupKeys, LAMBDA &&lambda)
 Apply the given functor to subgroups that can be casted to one of specified types. More...
 
template<typename GROUPTYPE = Group, typename ... GROUPTYPES, typename LOOKUP_CONTAINER , typename LAMBDA >
void forSubGroups (LOOKUP_CONTAINER const &subGroupKeys, LAMBDA &&lambda) const
 Apply the given functor to subgroups that can be casted to one of specified types. More...
 
template<typename LAMBDA >
void forWrappers (LAMBDA &&lambda)
 Apply the given functor to wrappers. More...
 
template<typename LAMBDA >
void forWrappers (LAMBDA &&lambda) const
 Apply the given functor to wrappers. More...
 
template<typename TYPE , typename ... TYPES, typename LAMBDA >
void forWrappers (LAMBDA &&lambda)
 Apply the given functor to wrappers that can be cast to one of specified types. More...
 
template<typename TYPE , typename ... TYPES, typename LAMBDA >
void forWrappers (LAMBDA &&lambda) const
 Apply the given functor to wrappers that can be cast to one of specified types. More...
 
void initialize ()
 Run initialization functions on this and all subgroups. More...
 
virtual void initializationOrder (string_array &order)
 Sets the initialization order for sub-Groups. More...
 
void initializePostInitialConditions ()
 Initialization routine to be called after calling ApplyInitialConditions(). More...
 
void postRestartInitializationRecursive ()
 Initialization routine to be called after calling reading a restart file. More...
 
void processInputFileRecursive (xmlWrapper::xmlDocument &xmlDocument, xmlWrapper::xmlNode &targetNode)
 Recursively read values using ProcessInputFile() from the input file and put them into the wrapped values for this group. Also add the includes content to the xmlDocument when Include nodes are encountered. More...
 
void processInputFileRecursive (xmlWrapper::xmlDocument &xmlDocument, xmlWrapper::xmlNode &targetNode, xmlWrapper::xmlNodePos const &nodePos)
 Same as processInputFileRecursive(xmlWrapper::xmlDocument &, xmlWrapper::xmlNode &) but allow to reuse an existing xmlNodePos. More...
 
void postInputInitializationRecursive ()
 Recursively call postInputInitialization() to apply post processing after reading input values.
 
template<typename T , typename TBASE = T>
Wrapper< TBASE > & registerWrapper (string const &name, wrapperMap::KeyIndex::index_type *const rkey=nullptr)
 Create and register a Wrapper around a new object. More...
 
template<typename T , typename TBASE = T>
Wrapper< TBASE > & registerWrapper (Group::wrapperMap::KeyIndex const &viewKey)
 Create and register a Wrapper around a new object. More...
 
template<typename T >
Wrapper< T > & registerWrapper (string const &name, std::unique_ptr< T > newObject)
 Register a Wrapper around a given object and take ownership. More...
 
template<typename T >
Wrapper< T > & registerWrapper (string const &name, T *newObject)
 Register a Wrapper around an existing object, does not take ownership of the object. More...
 
WrapperBaseregisterWrapper (std::unique_ptr< WrapperBase > wrapper)
 Register and take ownership of an existing Wrapper. More...
 
void deregisterWrapper (string const &name)
 Removes a Wrapper from this group. More...
 
void generateDataStructureSkeleton (integer const level)
 Build a complete datastructure for schema generation. More...
 
virtual void expandObjectCatalogs ()
 Expand any catalogs in the data structure.
 
virtual void setSchemaDeviations (xmlWrapper::xmlNode schemaRoot, xmlWrapper::xmlNode schemaParent, integer documentationType)
 Inform the schema generator of any deviations between the xml and GEOS data structures. More...
 
virtual void registerDataOnMeshRecursive (Group &meshBodies)
 Calls RegisterDataOnMesh() recursively. More...
 
virtual localIndex packSize (string_array const &wrapperNames, integer const recursive, bool onDevice, parallelDeviceEvents &events) const
 Get the size required to pack a list of wrappers. More...
 
virtual localIndex packSize (string_array const &wrapperNames, arrayView1d< localIndex const > const &packList, integer const recursive, bool onDevice, parallelDeviceEvents &events) const
 Get the size required to pack a list of indices within a list of wrappers. More...
 
localIndex packSize (arrayView1d< localIndex const > const &packList, integer const recursive, bool onDevice, parallelDeviceEvents &events) const
 Get the size required to pack a list of indices for all registered wrappers. More...
 
virtual localIndex pack (buffer_unit_type *&buffer, string_array const &wrapperNames, integer const recursive, bool onDevice, parallelDeviceEvents &events) const
 Pack a list of wrappers to a buffer. More...
 
virtual localIndex pack (buffer_unit_type *&buffer, string_array const &wrapperNames, arrayView1d< localIndex const > const &packList, integer const recursive, bool onDevice, parallelDeviceEvents &events) const
 Pack a list of indices within a list of wrappers. More...
 
localIndex pack (buffer_unit_type *&buffer, arrayView1d< localIndex const > const &packList, integer const recursive, bool onDevice, parallelDeviceEvents &events) const
 Pack a list of indices for all registered wrappers. More...
 
virtual localIndex unpack (buffer_unit_type const *&buffer, arrayView1d< localIndex > &packList, integer const recursive, bool onDevice, parallelDeviceEvents &events, MPI_Op op=MPI_REPLACE)
 Unpack a buffer. More...
 
template<typename KEY >
WrapperBase const & getWrapperBase (KEY const &key) const
 Return a reference to a WrapperBase stored in this group. More...
 
template<typename KEY >
WrapperBasegetWrapperBase (KEY const &key)
 Return a reference to a WrapperBase stored in this group. More...
 
indexType getWrapperIndex (string const &name) const
 
wrapperMap const & wrappers () const
 Get access to the internal wrapper storage. More...
 
wrapperMapwrappers ()
 Get access to the internal wrapper storage. More...
 
indexType numWrappers () const
 Return the number of wrappers. More...
 
std::vector< stringgetWrappersNames () const
 
template<typename LOOKUP_TYPE >
bool hasWrapper (LOOKUP_TYPE const &lookup) const
 Check if a wrapper exists. More...
 
template<typename T , typename LOOKUP_TYPE >
Wrapper< T > const & getWrapper (LOOKUP_TYPE const &index) const
 Retrieve a Wrapper stored in this group. More...
 
template<typename T , typename LOOKUP_TYPE >
Wrapper< T > & getWrapper (LOOKUP_TYPE const &index)
 Retrieve a Wrapper stored in this group. More...
 
template<typename T , typename LOOKUP_TYPE >
Wrapper< T > const * getWrapperPointer (LOOKUP_TYPE const &index) const
 Retrieve a Wrapper stored in this group. More...
 
template<typename T , typename LOOKUP_TYPE >
Wrapper< T > * getWrapperPointer (LOOKUP_TYPE const &index)
 Retrieve a Wrapper stored in this group. More...
 
template<typename T , typename LOOKUP_TYPE >
GEOS_DECLTYPE_AUTO_RETURN getReference (LOOKUP_TYPE const &lookup) const
 Look up a wrapper and get reference to wrapped object. More...
 
template<typename T , typename LOOKUP_TYPE >
T & getReference (LOOKUP_TYPE const &lookup)
 Look up a wrapper and get reference to wrapped object. More...
 
virtual void resize (localIndex const newSize)
 Resize the group and all contained wrappers that resize with parent. More...
 
virtual void reserve (indexType const newsize)
 Set the new capacity and reserve it in all wrappers that resize with parent. More...
 
localIndex capacity () const
 Get the "capacity" of the group, which determines the capacity of resizable wrappers. More...
 
localIndex size () const
 Get the "size" of the group, which determines the number of elements in resizable wrappers. More...
 
string const & getName () const
 Get group name. More...
 
string getPath () const
 Return the path of this Group in the data repository. Starts with '/' followed by the hierarchy of the children of the "Problem" in which the Group is. More...
 
DataContext const & getDataContext () const
 
template<typename KEY >
DataContext const & getWrapperDataContext (KEY key) const
 
GroupgetParent ()
 Access the group's parent. More...
 
Group const & getParent () const
 Access the group's parent. More...
 
bool hasParent () const
 
localIndex getIndexInParent () const
 Get the group's index within its parent group. More...
 
localIndex getSubGroupIndex (keyType const &key) const
 Get the index of a sub-Group within this group. More...
 
int sizedFromParent () const
 Check whether this Group is resized when its parent is resized. More...
 
GroupsetSizedFromParent (int val)
 Set whether this wrapper is resized when its parent is resized. More...
 
RestartFlags getRestartFlags () const
 Get flags that control restart output of this group. More...
 
void setRestartFlags (RestartFlags flags)
 Set flags that control restart output of this group. More...
 
InputFlags getInputFlags () const
 Get input flags for schema generation. More...
 
void setInputFlags (InputFlags flags)
 Set input flags for schema generation. More...
 
conduit::Node & getConduitNode ()
 Return the Conduit node object associated with this group. More...
 
conduit::Node const & getConduitNode () const
 Return the Conduit node object associated with this group. More...
 
void prepareToWrite ()
 Register the group and its wrappers with Conduit.
 
void finishWriting ()
 Write the group and its wrappers into Conduit.
 
void loadFromConduit ()
 Read the group and its wrappers from Conduit.
 
void enableLogLevelInput ()
 
void setLogLevel (integer const logLevel)
 Set verbosity level. More...
 
integer getLogLevel () const
 

Static Public Member Functions

static string coupledSolverAttributePrefix ()
 String used to form the solverName used to register solvers in CoupledSolver.
 
static string catalogName ()
 
- Static Public Member Functions inherited from geos::PhysicsSolverBase
static CatalogInterface::CatalogTypegetCatalog ()
 Get the singleton catalog for PhysicsSolverBase. More...
 
- Static Public Member Functions inherited from geos::dataRepository::Group
template<typename T0 , typename T1 , typename ... CASTTYPES, typename CONTAINERTYPE , typename LAMBDA >
static bool applyLambdaToContainer (CONTAINERTYPE &container, LAMBDA &&lambda)
 Apply a given functor to a container if the container can be cast to one of the specified types. More...
 
static CatalogInterface::CatalogTypegetCatalog ()
 Get the singleton catalog for this Group. More...
 

Public Attributes

geos::ElasticWaveEquationSEM::viewKeyStruct waveEquationViewKeys
 

Protected Member Functions

virtual void postInputInitialization () override final
 
virtual void initializePostInitialConditionsPreSubGroups () override final
 Called by InitializePostInitialConditions() prior to initializing sub-Groups.
 
- Protected Member Functions inherited from geos::WaveSolverBase
bool directoryExists (std::string const &directoryName)
 Utility function to check if a directory exists. More...
 
virtual void incrementIndexSeismoTrace (real64 const time_n)
 
virtual void computeAllSeismoTraces (real64 const time_n, real64 const dt, arrayView1d< real32 const > const var_np1, arrayView1d< real32 const > const var_n, arrayView2d< real32 > varAtReceivers, arrayView1d< real32 > coeffs={}, bool add=false)
 Computes the traces on all receivers (see @computeSeismoTraces) up to time_n+dt. More...
 
virtual void compute2dVariableAllSeismoTraces (localIndex const regionIndex, real64 const time_n, real64 const dt, arrayView2d< real32 const > const var_np1, arrayView2d< real32 const > const var_n, arrayView2d< real32 > varAtReceivers)
 Computes the traces on all receivers (see @computeSeismoTraces) up to time_n+dt. More...
 
localIndex getNumNodesPerElem ()
 
- Protected Member Functions inherited from geos::PhysicsSolverBase
real64 eisenstatWalker (real64 const newNewtonNorm, real64 const oldNewtonNorm, LinearSolverParameters::Krylov const &krylovParams)
 Eisenstat-Walker adaptive tolerance. More...
 
virtual void setConstitutiveNamesCallSuper (ElementSubRegionBase &subRegion) const
 This function sets constitutive name fields on an ElementSubRegionBase, and calls the base function it overrides. More...
 
- Protected Member Functions inherited from geos::dataRepository::Group
virtual void initializePostSubGroups ()
 Called by Initialize() after to initializing sub-Groups.
 
virtual void initializePostInitialConditionsPostSubGroups ()
 Called by InitializePostInitialConditions() after to initializing sub-Groups.
 
virtual void postRestartInitialization ()
 Performs initialization required after reading from a restart file.
 

Additional Inherited Members

- Static Public Attributes inherited from geos::WaveSolverBase
static constexpr real64 epsilonLoc = WaveSolverUtils::epsilonLoc
 
- Static Protected Member Functions inherited from geos::PhysicsSolverBase
template<typename CONSTITUTIVE_BASE_TYPE >
static string getConstitutiveName (ElementSubRegionBase const &subRegion)
 Get the Constitutive Name object. More...
 
template<typename CONSTITUTIVE_BASE_TYPE >
static string getConstitutiveName (ParticleSubRegionBase const &subRegion)
 Get the Constitutive Name object. More...
 
template<typename BASETYPE = constitutive::ConstitutiveBase, typename LOOKUP_TYPE >
static BASETYPE const & getConstitutiveModel (dataRepository::Group const &dataGroup, LOOKUP_TYPE const &key)
 Get the Constitutive Model object. More...
 
template<typename BASETYPE = constitutive::ConstitutiveBase, typename LOOKUP_TYPE >
static BASETYPE & getConstitutiveModel (dataRepository::Group &dataGroup, LOOKUP_TYPE const &key)
 Get the Constitutive Model object. More...
 
- Protected Attributes inherited from geos::WaveSolverBase
array2d< real64m_sourceCoordinates
 Coordinates of the sources in the mesh.
 
real32 m_timeSourceFrequency
 Central frequency for the Ricker time source.
 
real32 m_timeSourceDelay
 Source time delay (1 / f0 by default)
 
array2d< real64m_receiverCoordinates
 Coordinates of the receivers in the mesh.
 
localIndex m_rickerOrder
 Flag that indicates the order of the Ricker to be used, order 2 by default.
 
integer m_outputSeismoTrace
 Flag that indicates if we write the seismo trace in a file .txt, 0 no output, 1 otherwise.
 
real64 m_dtSeismoTrace
 Time step for seismoTrace output.
 
localIndex m_indexSeismoTrace
 Cycle number for output SeismoTrace.
 
localIndex m_nsamplesSeismoTrace
 Amount of seismoTrace that will be recorded for each receiver.
 
WaveSolverUtils::DASType m_useDAS
 Flag to indicate which DAS type will be modeled.
 
integer m_linearDASSamples
 Number of points used for strain integration for dipole DAS.
 
array2d< real64m_linearDASGeometry
 Geometry parameters for a linear DAS fiber (dip, azimuth, gauge length)
 
array1d< real32m_linearDASVectorX
 X component of the linear DAS direction vector.
 
array1d< real32m_linearDASVectorY
 Y component of the linear DAS direction vector.
 
array1d< real32m_linearDASVectorZ
 Z component of the linear DAS direction vector.
 
WaveSolverUtils::AttenuationType m_attenuationType
 Flag to indicate which attenuation type will be modeled.
 
array1d< real32m_slsReferenceAngularFrequencies
 Vector containing the reference frequencies for the standard-linear-solid (SLS) anelasticity model.
 
array1d< real32m_slsAnelasticityCoefficients
 Vector containing the anelasticity coefficients for the standard-linear-solid (SLS) anelasticity model.
 
localIndex m_forward
 Indicate if we want to compute forward ou backward.
 
localIndex m_saveFields
 Indicate if we want to save fields to restore them during backward.
 
integer m_shotIndex
 
integer m_usePML
 Flag to apply PML.
 
integer m_timestepStabilityLimit
 
real64 m_timeStep
 
array2d< localIndexm_sourceNodeIds
 Indices of the nodes (in the right order) for each source point.
 
array2d< real64m_sourceConstants
 Constant part of the source for the nodes listed in m_sourceNodeIds.
 
array1d< localIndexm_sourceIsAccessible
 Flag that indicates whether the source is local or not to the MPI rank.
 
array2d< localIndexm_receiverNodeIds
 Indices of the element nodes (in the right order) for each receiver point.
 
array2d< real64m_receiverConstants
 Basis function evaluated at the receiver for the nodes listed in m_receiverNodeIds.
 
array1d< localIndexm_receiverIsLocal
 Flag that indicates whether the receiver is local or not to the MPI rank.
 
array1d< localIndexm_receiverElem
 Array containing the elements which contain a receiver.
 
array1d< localIndexm_receiverRegion
 Array containing the elements which contain the region which the receiver belongs.
 
localIndex m_enableLifo
 Flag to enable LIFO.
 
localIndex m_lifoSize
 lifo size (should be the total number of buffer to save in LIFO)
 
localIndex m_lifoOnDevice
 Number of buffers to store on device by LIFO (if negative, opposite of percentage of remaining memory)
 
localIndex m_lifoOnHost
 Number of buffers to store on host by LIFO (if negative, opposite of percentage of remaining memory)
 
std::unique_ptr< LifoStorage< real32, localIndex > > m_lifo
 LIFO to store p_dt2.
 
SortedArray< localIndexm_solverTargetNodesSet
 A set of target nodes IDs that will be handled by the current solver.
 
array1d< stringm_sourceWaveletTableNames
 Names of table functions for source wavelet (time dependency)
 
bool m_useSourceWaveletTables
 Flag to indicate if source wavelet table functions are used.
 
array1d< TableFunction::KernelWrapperm_sourceWaveletTableWrappers
 Wrappers of table functions for source wavelet (time dependency)
 
- Protected Attributes inherited from geos::PhysicsSolverBase
real64 m_cflFactor
 Courant–Friedrichs–Lewy factor for the timestep.
 
real64 m_maxStableDt
 maximum stable time step
 
real64 m_nextDt
 timestep of the next cycle
 
integer m_numTimestepsSinceLastDtCut
 Number of cycles since last timestep cut.
 
string m_discretizationName
 name of the FV discretization object in the data repository
 
DofManager m_dofManager
 Data structure to handle degrees of freedom.
 
ParallelMatrix m_matrix
 System matrix.
 
ParallelVector m_rhs
 System right-hand side vector.
 
ParallelVector m_solution
 System solution vector.
 
CRSMatrix< real64, globalIndexm_localMatrix
 Local system matrix and rhs.
 
std::unique_ptr< PreconditionerBase< LAInterface > > m_precond
 Custom preconditioner for the "native" iterative solver.
 
integer m_writeLinearSystem
 flag for debug output of matrix, rhs, and solution
 
LinearSolverParametersInput m_linearSolverParameters
 Linear solver parameters.
 
LinearSolverResult m_linearSolverResult
 Result of the last linear solve.
 
NonlinearSolverParameters m_nonlinearSolverParameters
 Nonlinear solver parameters.
 
SolverStatistics m_solverStatistics
 Solver statistics.
 
Timestamp m_systemSetupTimestamp
 Timestamp of the last call to setup system.
 
std::function< void(CRSMatrix< real64, globalIndex >, array1d< real64 >) > m_assemblyCallback
 Callback function for assembly step.
 
std::map< std::string, std::chrono::system_clock::duration > m_timers
 Timers for the aggregate profiling of the solver.
 

Detailed Description

Definition at line 32 of file ElasticWaveEquationSEM.hpp.

Member Function Documentation

◆ addSourceToRightHandSide()

void geos::ElasticWaveEquationSEM::addSourceToRightHandSide ( real64 const &  time_n,
arrayView1d< real32 > const  rhsx,
arrayView1d< real32 > const  rhsy,
arrayView1d< real32 > const  rhsz 
)

Multiply the precomputed term by the Ricker and add to the right-hand side.

Parameters
cycleNumberthe cycle number/step number of evaluation of the source
rhsxthe right hand side vector to be computed (x-component)
rhsythe right hand side vector to be computed (y-component)
rhszthe right hand side vector to be computed (z-component)

◆ computeDAS()

void geos::ElasticWaveEquationSEM::computeDAS ( arrayView2d< real32 > const  xCompRcv,
arrayView2d< real32 > const  yCompRcv,
arrayView2d< real32 > const  zCompRcv 
)

Compute DAS data as a difference of the field at two points, from the appropriate three-component receiver pairs, when the DAS type is set to 2.

TODO: move implementation into WaveSolverBase once 'm_receiverIsLocal' is also moved

Parameters
xCompRcvthe array holding the x-component of pairs of receivers
yCompRcvthe array holding the y-component of pairs of receivers
zCompRcvthe array holding the z-component of pairs of receivers

◆ explicitStepInternal()

real64 geos::ElasticWaveEquationSEM::explicitStepInternal ( real64 const &  time_n,
real64 const &  dt,
DomainPartition domain 
)

internal function to the class to compute explicitStep either for backward or forward. (requires not to be private because it is called from GEOS_HOST_DEVICE method)

Parameters
time_ntime at the beginning of the step
dtthe perscribed timestep
cycleNumberthe current cycle number
meshBodyNamethe name of the mesh body
domainthe domain object
Returns
return the timestep that was achieved during the step.

◆ getCatalogName()

string geos::ElasticWaveEquationSEM::getCatalogName ( ) const
inlineoverridevirtual

Returns
Get the final class Catalog name

Implements geos::PhysicsSolverBase.

Definition at line 58 of file ElasticWaveEquationSEM.hpp.

◆ postInputInitialization()

virtual void geos::ElasticWaveEquationSEM::postInputInitialization ( )
finaloverrideprotectedvirtual

This function provides capability to post process input values prior to any other initialization operations.

Reimplemented from geos::WaveSolverBase.

◆ registerDataOnMesh()

virtual void geos::ElasticWaveEquationSEM::registerDataOnMesh ( Group MeshBodies)
finaloverridevirtual

Register wrappers that contain data on the mesh objects.

Parameters
MeshBodiesthe group of mesh bodies

Reimplemented from geos::WaveSolverBase.


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