https://mooseframework.inl.gov
Loading...
Searching...
No Matches
Public Member Functions | Protected Member Functions | Protected Attributes | Private Attributes | List of all members
UELThread Class Reference

#include <UELThread.h>

Inheritance diagram for UELThread:
[legend]

Public Member Functions

 UELThread (FEProblemBase &fe_problem, AbaqusUserElement &uel_uo)
 
 UELThread (UELThread &x, Threads::split split)
 
void join (const UELThread &)
 
virtual void caughtMooseException (MooseException &e) override
 
virtual bool keepGoing () override
 
virtual void preElement (const Elem *elem) override
 
virtual void preInternalSide (const Elem *elem, unsigned int side) override
 
virtual void preBoundary (const Elem *elem, unsigned int side, BoundaryID bnd_id, const Elem *lower_d_elem=nullptr) override
 
virtual void neighborSubdomainChanged () override
 
virtual void operator() (const RangeType &range, bool bypass_threading=false)
 
virtual void pre ()
 
virtual void post ()
 
virtual void postElement (const Elem *elem)
 
virtual void onBoundary (const Elem *elem, unsigned int side, BoundaryID bnd_id, const Elem *lower_d_elem=nullptr)
 
virtual void postInternalSide (const Elem *elem, unsigned int side)
 
virtual void onInternalSide (const Elem *elem, unsigned int side)
 
virtual void onExternalSide (const Elem *elem, unsigned int side)
 
virtual void onInterface (const Elem *elem, unsigned int side, BoundaryID bnd_id)
 

Protected Member Functions

virtual void subdomainChanged () override final
 
virtual void onElement (const Elem *elem) override final
 Fortran array memory layout: (1,1), (2,1) (3,1) (1,2) (2,2) (3,2) (1,3) (2,3) (3,3) C++ array memory layout: [0][0], [0][1], [0][2], [1][0], [1][1], [1][2], [2][0], [2][1], [2][2].
 
void prepareElement (const Elem *elem)
 
void clearVarsAndMaterials ()
 
void printExecutionOrdering (const std::vector< T * > &objs, const bool print_header=true, const std::string &line_prefix="[DBG]") const
 
void printExecutionOrdering (const std::vector< std::shared_ptr< T > > &objs_ptrs, const bool print_header=true, const std::string &line_prefix="[DBG]") const
 
virtual void printGeneralExecutionInformation () const
 
virtual void printBlockExecutionInformation () const
 
virtual void printBoundaryExecutionInformation (const unsigned int) const
 
void resetExecPrintedSets () const
 
virtual bool shouldComputeInternalSide (const Elem &elem, const Elem &neighbor) const
 

Protected Attributes

FEProblemBase & _fe_problem
 
MooseMesh & _mesh
 
THREAD_ID _tid
 
SubdomainID _subdomain
 
SubdomainID _old_subdomain
 
SubdomainID _neighbor_subdomain
 
SubdomainID _old_neighbor_subdomain
 
std::set< SubdomainID > _blocks_exec_printed
 
std::set< BoundaryID > _boundaries_exec_printed
 

Private Attributes

NonlinearSystemBase & _sys
 Current nonlinear system.
 
AuxiliarySystem * _aux_sys
 Auxiliary system object.
 
std::vector< dof_id_type > _var_dof_indices
 dof indices of all coupled variables
 
std::vector< dof_id_type > _all_dof_indices
 
std::vector< Real > _all_dof_values
 
std::vector< Real > _all_dof_increments
 
std::vector< Real > _all_udot_dof_values
 
std::vector< Real > _all_udotdot_dof_values
 
std::vector< dof_id_type > _aux_var_dof_indices
 
std::vector< dof_id_type > _all_aux_var_dof_indices
 
std::vector< Real > _all_aux_var_dof_increments
 
std::vector< Real > _all_aux_var_dof_values
 
std::vector< Real > _aux_var_values_to_uel
 
DenseVector< Real > _local_re
 
DenseMatrix< Real > _local_ke
 
const std::vector< const MooseVariableFieldBase * > & _variables
 
const std::vector< const MooseVariableFieldBase * > & _aux_variables
 
AbaqusUserElement & _uel_uo
 reference to the userobject (to access parameters)
 
const AbaqusUserElement::uel_t & _uel
 have a reference to the UEL plugin here
 
std::array< int, 5 > _lflags
 parameters for the UEL plugin
 
std::vector< Real > _coords
 
std::vector< Real > _statev_copy
 state variable copy
 

Detailed Description

Definition at line 17 of file UELThread.h.

Constructor & Destructor Documentation

◆ UELThread() [1/2]

UELThread::UELThread ( FEProblemBase &  fe_problem,
AbaqusUserElement &  uel_uo 
)

Definition at line 13 of file UELThread.C.

14 : ThreadedElementLoop<ConstElemRange>(fe_problem),
15 _sys(fe_problem.currentNonlinearSystem()),
16 _aux_sys(&_fe_problem.getAuxiliarySystem()),
17 _variables(uel_uo.getVariables()),
18 _aux_variables(uel_uo.getAuxVariables()),
19 _uel_uo(uel_uo),
20 _uel(uel_uo.getPlugin()),
21 _statev_copy(uel_uo._nstatev)
22{
23 // general solve step
24 _lflags[3] = 0;
25
26 // newton based solution (should be 1 when using a predictor or maybe at the start of the
27 // iteration)
28 _lflags[4] = 0;
29}
AbaqusUserElement::getPlugin
const uel_t & getPlugin() const
Definition AbaqusUserElement.h:103
AbaqusUserElement::_nstatev
int _nstatev
stateful data
Definition AbaqusUserElement.h:150
AbaqusUserElement::getVariables
const std::vector< const MooseVariableFieldBase * > & getVariables() const
getters for the loop class
Definition AbaqusUserElement.h:97
AbaqusUserElement::getAuxVariables
const std::vector< const MooseVariableFieldBase * > & getAuxVariables() const
Definition AbaqusUserElement.h:98
FEProblemBase::getAuxiliarySystem
AuxiliarySystem & getAuxiliarySystem()
FEProblemBase::currentNonlinearSystem
NonlinearSystemBase & currentNonlinearSystem()
UELThread::_variables
const std::vector< const MooseVariableFieldBase * > & _variables
Definition UELThread.h:56
UELThread::_statev_copy
std::vector< Real > _statev_copy
state variable copy
Definition UELThread.h:71
UELThread::_sys
NonlinearSystemBase & _sys
Current nonlinear system.
Definition UELThread.h:33
UELThread::_aux_sys
AuxiliarySystem * _aux_sys
Auxiliary system object.
Definition UELThread.h:36
UELThread::_uel_uo
AbaqusUserElement & _uel_uo
reference to the userobject (to access parameters)
Definition UELThread.h:61
UELThread::_aux_variables
const std::vector< const MooseVariableFieldBase * > & _aux_variables
Definition UELThread.h:58
UELThread::_uel
const AbaqusUserElement::uel_t & _uel
have a reference to the UEL plugin here
Definition UELThread.h:64
UELThread::_lflags
std::array< int, 5 > _lflags
parameters for the UEL plugin
Definition UELThread.h:67

◆ UELThread() [2/2]

UELThread::UELThread ( UELThread &  x,
Threads::split  split 
)

Definition at line 32 of file UELThread.C.

33 : ThreadedElementLoop<ConstElemRange>(x, split),
34 _sys(x._sys),
35 _aux_sys(x._aux_sys),
36 _variables(x._variables),
37 _aux_variables(x._aux_variables),
38 _uel_uo(x._uel_uo),
39 _uel(x._uel),
40 _lflags(x._lflags),
41 _statev_copy(_uel_uo._nstatev)
42{
43}
x
const std::vector< double > x
Definition EquilibriumConstantFitTest.C:17

Member Function Documentation

◆ join()

void UELThread::join ( const UELThread &  )
inline

Definition at line 25 of file UELThread.h.

25{}

◆ onElement()

void UELThread::onElement ( const Elem *  elem)
finaloverrideprotectedvirtual

Fortran array memory layout: (1,1), (2,1) (3,1) (1,2) (2,2) (3,2) (1,3) (2,3) (3,3) C++ array memory layout: [0][0], [0][1], [0][2], [1][0], [1][1], [1][2], [2][0], [2][1], [2][2].

Reimplemented from ThreadedElementLoop< ConstElemRange >.

Definition at line 56 of file UELThread.C.

57{
58 // get all dof indices for the coupled variables on this element
59 int nnode = elem->n_nodes();
60 const auto nvar = _variables.size();
61 _all_dof_indices.resize(nnode * nvar);
62
63 // ** System variables **
64 // prepare DOF indices in the correct order
65 for (const auto i : index_range(_variables))
66 {
67 _variables[i]->getDofIndices(elem, _var_dof_indices);
68
69 // sanity checks
70 if (_variables[i]->scalingFactor() != 1)
71 mooseError("Scaling factors other than unity are not yet supported");
72 if (static_cast<int>(_var_dof_indices.size()) != nnode)
73 mooseError("All coupled variables must be full order lagrangian");
74
75 for (const auto j : make_range(nnode))
76 _all_dof_indices[j * nvar + i] = _var_dof_indices[j];
77 }
78
79 int ndofel = _all_dof_indices.size();
80
81 // Get solution values
82 _all_dof_values.resize(ndofel);
83
84 _sys.currentSolution()->get(_all_dof_indices, _all_dof_increments);
85 _all_dof_increments.resize(ndofel);
86 _sys.solutionOld().get(_all_dof_indices, _all_dof_values);
87
88 mooseAssert(_all_dof_values.size() == _all_dof_increments.size(), "Inconsistent solution size.");
89 for (const auto i : index_range(_all_dof_values))
90 _all_dof_increments[i] -= _all_dof_values[i];
91
92 _all_udot_dof_values.resize(ndofel);
93 _all_udotdot_dof_values.resize(ndofel);
94
95 // Get u_dot and u_dotdot solution values (required for future expansion of the interface)
96 if (false)
97 {
98 _all_udot_dof_values.resize(ndofel);
99 _sys.solutionUDot()->get(_all_dof_indices, _all_udot_dof_values);
100 _all_udotdot_dof_values.resize(ndofel);
101 _sys.solutionUDot()->get(_all_dof_indices, _all_udotdot_dof_values);
102 }
103
104 // Prepare external fields
105 const auto nvar_aux = _aux_variables.size();
106 _all_aux_var_dof_indices.resize(nnode * nvar_aux);
107 _all_aux_var_dof_increments.resize(nnode * nvar_aux);
108
109 for (const auto i : index_range(_aux_variables))
110 {
111 _aux_variables[i]->getDofIndices(elem, _aux_var_dof_indices);
112
113 if (static_cast<int>(_aux_var_dof_indices.size()) != nnode)
114 mooseError("All auxiliary variables must be full order Lagrangian");
115
116 for (const auto j : make_range(nnode))
117 _all_aux_var_dof_indices[j * nvar_aux + i] = _aux_var_dof_indices[j];
118 }
119
120 _all_aux_var_dof_values.resize(nnode * nvar_aux);
121 _aux_var_values_to_uel.resize(nnode * nvar_aux * 2); // Value _and_ increment
122
123 _aux_sys->currentSolution()->get(_all_aux_var_dof_indices, _all_aux_var_dof_increments);
124 _all_aux_var_dof_increments.resize(nnode * nvar_aux);
125 _aux_sys->solutionOld().get(_all_aux_var_dof_indices, _all_aux_var_dof_values);
126
127 // First, one external field and increment; then, second external field and increment, etc.
128 for (const auto i : index_range(_all_aux_var_dof_values))
129 _all_aux_var_dof_increments[i] -= _all_aux_var_dof_values[i];
130
131 for (const auto i : index_range(_all_aux_var_dof_values))
132 {
133 _aux_var_values_to_uel[i * 2] = _all_aux_var_dof_values[i];
134 _aux_var_values_to_uel[i * 2 + 1] = _all_aux_var_dof_increments[i];
135 }
136 // End of prepare external fields.
137
138 const bool do_residual = _sys.hasVector(_sys.residualVectorTag());
139 const bool do_jacobian = _sys.hasMatrix(_sys.systemMatrixTag());
140
141 // set flags
142 if (do_residual && do_jacobian)
143 _lflags[2] = 0;
144 else if (!do_residual && do_jacobian)
145 _lflags[2] = 4;
146 else if (do_residual && !do_jacobian)
147 _lflags[2] = 5;
148 else
149 _lflags[2] = 0;
150
151 // copy coords
152 int dim = _uel_uo._dim;
153 _coords.resize(nnode * dim);
154 for (const auto i : make_range(nnode))
155 for (const auto j : make_range(dim))
156 _coords[j + dim * i] = elem->node_ref(i)(j);
157
158 // prepare residual and jacobian storage
159 _local_re.resize(ndofel);
160 _local_ke.resize(ndofel, ndofel);
161
162 int nrhs = 1; // : RHS should contain the residual vector
163 int jtype = _uel_uo._jtype; // type of user element
164
165 Real dt = _fe_problem.dt();
166 Real time = _fe_problem.time();
167 std::vector<Real> times{time - dt, time - dt}; // first entry should be the step time (TODO)
168
169 std::array<Real, 8> energy;
170 int jelem = elem->id() + 1; // User-assigned element number
171 Real pnewdt;
172
173 int npredf = nvar_aux; // Number of external fields.
174
175 // dummy vars
176 Real rdummy = 0;
177 int idummy = 0;
178
179 // stateful data
180 if (_uel_uo._nstatev)
181 {
182 const auto & statev_old = _uel_uo._statev[_uel_uo._statev_index_old][elem->id()];
183 std::copy(statev_old.begin(), statev_old.end(), _statev_copy.begin());
184 }
185
186 // call the plugin
187 _uel(_local_re.get_values().data(),
188 _local_ke.get_values().data(),
189 _statev_copy.data(),
190 energy.data(),
191 &ndofel,
192 &nrhs,
193 &_uel_uo._nstatev,
194 _uel_uo._props.data(),
195 &_uel_uo._nprops,
196 _coords.data(),
197 &dim,
198 &nnode,
199 _all_dof_values.data() /* U[] */,
200 _all_dof_increments.data() /* DU[] */,
201 _all_udot_dof_values.data() /* V[] */,
202 _all_udotdot_dof_values.data() /* A[] */,
203 &jtype,
204 times.data(),
205 &dt,
206 &idummy /* KSTEP */,
207 &idummy /* KINC */,
208 &jelem,
209 nullptr /* PARAMS[] */,
210 &idummy /* NDLOAD */,
211 nullptr /* JDLTYP[] */,
212 nullptr /* ADLMAG[] */,
213 _aux_var_values_to_uel.data() /* PREDEF[] */,
214 &npredf /* NPREDF */,
215 nullptr /* LFLAGS[] */,
216 &ndofel /* MLVARX */,
217 nullptr /* DDLMAG[] */,
218 &idummy /* MDLOAD */,
219 &pnewdt,
220 nullptr /* JPROPS[] */,
221 &idummy /* NJPROP */,
222 &rdummy /* PERIOD */
223 );
224
225 if (_uel_uo._nstatev)
226 {
227 auto & statev_current = _uel_uo._statev[_uel_uo._statev_index_current][elem->id()];
228 std::copy(_statev_copy.begin(), _statev_copy.end(), statev_current.begin());
229 }
230
231 // write to the residual vector
232 // sign of 'residuals' has been tested with external loading and matches that of moose-umat
233 // setups.
234 if (do_residual)
235 _uel_uo.addResiduals(
236 _fe_problem.assembly(_tid, _sys.number()), _local_re, _all_dof_indices, -1.0);
237
238 // write to the Jacobian (hope we don't have to transpose...)
239 if (do_jacobian)
240 _uel_uo.addJacobian(_fe_problem.assembly(_tid, _sys.number()),
241 _local_ke,
242 _all_dof_indices,
243 _all_dof_indices,
244 -1.0);
245}
mooseError
void mooseError(Args &&... args)
for
for(PetscInt i=0;i< nvars;++i)
dim
unsigned int dim
AbaqusUserElement::_statev_index_old
std::size_t _statev_index_old
Definition AbaqusUserElement.h:153
AbaqusUserElement::_props
std::vector< Real > _props
props
Definition AbaqusUserElement.h:146
AbaqusUserElement::_jtype
const int _jtype
Abaqus element type.
Definition AbaqusUserElement.h:157
AbaqusUserElement::_statev_index_current
std::size_t _statev_index_current
Definition AbaqusUserElement.h:152
AbaqusUserElement::_statev
std::array< std::map< dof_id_type, std::vector< Real > >, 2 > _statev
Definition AbaqusUserElement.h:151
AbaqusUserElement::_dim
const unsigned int _dim
The dimension of the mesh, e.g. 3 for hexes and tets, 2 for quads and tris.
Definition AbaqusUserElement.h:125
AuxiliarySystem::currentSolution
const NumericVector< Number > *const & currentSolution() const override
FEProblemBase::dt
virtual Real & dt() const
FEProblemBase::assembly
virtual Assembly & assembly(const THREAD_ID tid, const unsigned int sys_num) override
FEProblemBase::time
virtual Real & time() const
NonlinearSystemBase::systemMatrixTag
TagID systemMatrixTag() const override
NonlinearSystemBase::residualVectorTag
TagID residualVectorTag() const override
NonlinearSystemBase::currentSolution
virtual const NumericVector< Number > *const & currentSolution() const override final
NonlinearSystemBase::hasVector
bool hasVector(const std::string &tag_name) const
NonlinearSystemBase::solutionUDot
virtual NumericVector< Number > * solutionUDot()
NonlinearSystemBase::number
unsigned int number() const
NonlinearSystemBase::solutionOld
NumericVector< Number > & solutionOld()
NonlinearSystemBase::hasMatrix
virtual bool hasMatrix(TagID tag) const
TaggingInterface::addJacobian
void addJacobian(Assembly &assembly, const Residuals &residuals, const Indices &dof_indices, Real scaling_factor)
TaggingInterface::addResiduals
void addResiduals(Assembly &assembly, const Residuals &residuals, const Indices &dof_indices, Real scaling_factor)
UELThread::_coords
std::vector< Real > _coords
Definition UELThread.h:68
UELThread::_all_udotdot_dof_values
std::vector< Real > _all_udotdot_dof_values
Definition UELThread.h:44
UELThread::_all_aux_var_dof_increments
std::vector< Real > _all_aux_var_dof_increments
Definition UELThread.h:49
UELThread::_var_dof_indices
std::vector< dof_id_type > _var_dof_indices
dof indices of all coupled variables
Definition UELThread.h:39
UELThread::_all_dof_indices
std::vector< dof_id_type > _all_dof_indices
Definition UELThread.h:40
UELThread::_aux_var_values_to_uel
std::vector< Real > _aux_var_values_to_uel
Definition UELThread.h:51
UELThread::_all_udot_dof_values
std::vector< Real > _all_udot_dof_values
Definition UELThread.h:43
UELThread::_all_aux_var_dof_indices
std::vector< dof_id_type > _all_aux_var_dof_indices
Definition UELThread.h:48
UELThread::_local_re
DenseVector< Real > _local_re
Definition UELThread.h:53
UELThread::_local_ke
DenseMatrix< Real > _local_ke
Definition UELThread.h:54
UELThread::_all_dof_increments
std::vector< Real > _all_dof_increments
Definition UELThread.h:42
UELThread::_aux_var_dof_indices
std::vector< dof_id_type > _aux_var_dof_indices
Definition UELThread.h:47
UELThread::_all_aux_var_dof_values
std::vector< Real > _all_aux_var_dof_values
Definition UELThread.h:50
UELThread::_all_dof_values
std::vector< Real > _all_dof_values
Definition UELThread.h:41
libMesh::DenseMatrix::get_values
std::vector< T > & get_values()
libMesh::DenseMatrix::resize
void resize(const unsigned int new_m, const unsigned int new_n)
libMesh::NumericVector::get
virtual void get(const std::vector< numeric_index_type > &index, T *values) const
libMesh::index_range
auto index_range(const T &sizable)
libMesh::Real
DIE A HORRIBLE DEATH HERE typedef LIBMESH_DEFAULT_SCALAR_TYPE Real
libMesh::make_range
IntRange< T > make_range(T beg, T end)

◆ subdomainChanged()

void UELThread::subdomainChanged ( )
finaloverrideprotectedvirtual

Reimplemented from ThreadedElementLoop< ConstElemRange >.

Definition at line 46 of file UELThread.C.

47{
48}

Member Data Documentation

◆ _all_aux_var_dof_increments

std::vector<Real> UELThread::_all_aux_var_dof_increments
private

Definition at line 49 of file UELThread.h.

Referenced by onElement().

◆ _all_aux_var_dof_indices

std::vector<dof_id_type> UELThread::_all_aux_var_dof_indices
private

Definition at line 48 of file UELThread.h.

Referenced by onElement().

◆ _all_aux_var_dof_values

std::vector<Real> UELThread::_all_aux_var_dof_values
private

Definition at line 50 of file UELThread.h.

Referenced by onElement().

◆ _all_dof_increments

std::vector<Real> UELThread::_all_dof_increments
private

Definition at line 42 of file UELThread.h.

Referenced by onElement().

◆ _all_dof_indices

std::vector<dof_id_type> UELThread::_all_dof_indices
private

Definition at line 40 of file UELThread.h.

Referenced by onElement().

◆ _all_dof_values

std::vector<Real> UELThread::_all_dof_values
private

Definition at line 41 of file UELThread.h.

Referenced by onElement().

◆ _all_udot_dof_values

std::vector<Real> UELThread::_all_udot_dof_values
private

Definition at line 43 of file UELThread.h.

Referenced by onElement().

◆ _all_udotdot_dof_values

std::vector<Real> UELThread::_all_udotdot_dof_values
private

Definition at line 44 of file UELThread.h.

Referenced by onElement().

◆ _aux_sys

AuxiliarySystem* UELThread::_aux_sys
private

Auxiliary system object.

Definition at line 36 of file UELThread.h.

Referenced by onElement().

◆ _aux_var_dof_indices

std::vector<dof_id_type> UELThread::_aux_var_dof_indices
private

Definition at line 47 of file UELThread.h.

Referenced by onElement().

◆ _aux_var_values_to_uel

std::vector<Real> UELThread::_aux_var_values_to_uel
private

Definition at line 51 of file UELThread.h.

Referenced by onElement().

◆ _aux_variables

const std::vector<const MooseVariableFieldBase *>& UELThread::_aux_variables
private

Definition at line 58 of file UELThread.h.

Referenced by onElement().

◆ _coords

std::vector<Real> UELThread::_coords
private

Definition at line 68 of file UELThread.h.

Referenced by onElement().

◆ _lflags

std::array<int, 5> UELThread::_lflags
private

parameters for the UEL plugin

Definition at line 67 of file UELThread.h.

Referenced by onElement(), and UELThread().

◆ _local_ke

DenseMatrix<Real> UELThread::_local_ke
private

Definition at line 54 of file UELThread.h.

Referenced by onElement().

◆ _local_re

DenseVector<Real> UELThread::_local_re
private

Definition at line 53 of file UELThread.h.

Referenced by onElement().

◆ _statev_copy

std::vector<Real> UELThread::_statev_copy
private

state variable copy

Definition at line 71 of file UELThread.h.

Referenced by onElement().

◆ _sys

NonlinearSystemBase& UELThread::_sys
private

Current nonlinear system.

Definition at line 33 of file UELThread.h.

Referenced by onElement().

◆ _uel

const AbaqusUserElement::uel_t& UELThread::_uel
private

have a reference to the UEL plugin here

Definition at line 64 of file UELThread.h.

Referenced by onElement().

◆ _uel_uo

AbaqusUserElement& UELThread::_uel_uo
private

reference to the userobject (to access parameters)

Definition at line 61 of file UELThread.h.

Referenced by onElement().

◆ _var_dof_indices

std::vector<dof_id_type> UELThread::_var_dof_indices
private

dof indices of all coupled variables

Definition at line 39 of file UELThread.h.

Referenced by onElement().

◆ _variables

const std::vector<const MooseVariableFieldBase *>& UELThread::_variables
private

Definition at line 56 of file UELThread.h.

Referenced by onElement().

The documentation for this class was generated from the following files:
Generated on Fri Aug 21 2026 13:44:02 for https://mooseframework.inl.gov by doxygen 1.9.8