Skip to content

Commit 077ca17

Browse files
dschwendschwen
committed
Add variable shim for FFT (idaholab#401)
1 parent e16e74f commit 077ca17

File tree

2 files changed

+196
-0
lines changed

2 files changed

+196
-0
lines changed

‎include/variables/MooseFFTVariable.h

+175
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,175 @@
1+
/**********************************************************************/
2+
/* DO NOT MODIFY THIS HEADER */
3+
/* MAGPIE - Mesoscale Atomistic Glue Program for Integrated Execution */
4+
/* */
5+
/* Copyright 2017 Battelle Energy Alliance, LLC */
6+
/* ALL RIGHTS RESERVED */
7+
/**********************************************************************/
8+
9+
#pragma once
10+
11+
#include "MooseVariableFEBase.h"
12+
13+
class MooseFFTVariable : public MooseVariableFEBase
14+
{
15+
public:
16+
static InputParameters validParams();
17+
18+
MooseFFTVariable(const InputParameters & parameters);
19+
20+
virtual bool isNodal() const { return false; }
21+
22+
/**
23+
* Clear out the dof indices. We do this in case this variable is not going to be prepared at
24+
* all...
25+
*/
26+
virtual void clearDofIndices() {}
27+
28+
/**
29+
* Prepare the elemental degrees of freedom
30+
*/
31+
virtual void prepare() {}
32+
33+
/**
34+
* Prepare the neighbor element degrees of freedom
35+
*/
36+
virtual void prepareNeighbor() { mooseError("Neighbor FFT variables are not supported yet."); }
37+
38+
/**
39+
* Prepare a lower dimensional element's degrees of freedom
40+
*/
41+
virtual void prepareLowerD()
42+
{
43+
mooseError("Lower dimensional FFT variables are not supported yet.");
44+
}
45+
46+
virtual void prepareAux() {}
47+
48+
virtual void reinitNode() {}
49+
virtual void reinitAux() {}
50+
virtual void reinitAuxNeighbor() { mooseError("Neighbor FFT variables are not supported yet."); }
51+
52+
virtual void reinitNodes(const std::vector<dof_id_type> &)
53+
{
54+
mooseError("Nodal FFT variables are not supported.");
55+
}
56+
virtual void reinitNodesNeighbor(const std::vector<dof_id_type> & nodes)
57+
{
58+
mooseError("Nodal FFT variables are not supported.");
59+
}
60+
61+
/**
62+
* Field type of this variable
63+
*/
64+
virtual Moose::VarFieldType fieldType() const { return Moose::VarFieldType::VAR_FIELD_STANDARD; }
65+
66+
/**
67+
* @returns true if this is a vector-valued element, false otherwise.
68+
*/
69+
virtual bool isVector() const { return false; };
70+
71+
/**
72+
* Is this variable defined at nodes
73+
* @return true if it the variable is defined at nodes, otherwise false
74+
*/
75+
virtual bool isNodalDefined() const { return false; }
76+
77+
virtual const dof_id_type & nodalDofIndex() const
78+
{
79+
mooseError("Nodal FFT variables are not supported.");
80+
}
81+
82+
virtual const dof_id_type & nodalDofIndexNeighbor() const
83+
{
84+
mooseError("Nodal FFT variables are not supported.");
85+
}
86+
87+
/**
88+
* Current element this variable is evaluated at
89+
*/
90+
virtual const Elem * const & currentElem() const
91+
{
92+
mooseError("Current element access not supported.");
93+
}
94+
95+
/**
96+
* The subdomains the variable is active on
97+
*/
98+
virtual const std::set<SubdomainID> & activeSubdomains() const
99+
{
100+
mooseError("Active subdomain access not supported.");
101+
}
102+
/**
103+
* Is the variable active on the subdomain?
104+
* @param subdomain The subdomain id in question
105+
* @return true if active on subdomain, false otherwise
106+
*/
107+
virtual bool activeOnSubdomain(SubdomainID subdomain) const { return true; }
108+
109+
/**
110+
* Prepare the initial condition
111+
*/
112+
virtual void prepareIC() {}
113+
114+
/**
115+
* Compute values at interior quadrature points
116+
*/
117+
virtual void computeElemValues()
118+
{ // meat!
119+
}
120+
121+
/**
122+
* Compute values at facial quadrature points
123+
*/
124+
virtual void computeElemValuesFace() {}
125+
/**
126+
* Compute values at facial quadrature points for the neighbor
127+
*/
128+
virtual void computeNeighborValuesFace() {}
129+
/**
130+
* Compute values at quadrature points for the neighbor
131+
*/
132+
virtual void computeNeighborValues() {}
133+
/**
134+
* compute values at quadrature points on the lower dimensional element
135+
*/
136+
virtual void computeLowerDValues() {}
137+
/**
138+
* Compute nodal values of this variable in the neighbor
139+
*/
140+
virtual void computeNodalNeighborValues() {}
141+
/**
142+
* Compute nodal values of this variable
143+
*/
144+
virtual void computeNodalValues() {}
145+
146+
virtual void getDofIndices(const Elem * elem, std::vector<dof_id_type> & dof_indices) const {}
147+
/**
148+
* Get neighbor DOF indices for currently selected element
149+
* @return the neighbor degree of freedom indices
150+
*/
151+
virtual const std::vector<dof_id_type> & dofIndicesNeighbor() const { return _no_dofs; }
152+
153+
/**
154+
* Get dof indices for the current lower dimensional element (this is meaningful when performing
155+
* mortar FEM)
156+
* @return the lower dimensional element's dofs
157+
*/
158+
virtual const std::vector<dof_id_type> & dofIndicesLower() const { return _no_dofs; }
159+
160+
virtual unsigned int numberOfDofsNeighbor() { return 0; }
161+
162+
virtual void insert(NumericVector<Number> & residual) {}
163+
virtual void add(NumericVector<Number> & residual) {}
164+
165+
///@{ FFT variables have no shape functions
166+
virtual size_t phiSize() const { return 0; }
167+
virtual size_t phiFaceSize() const { return 0; }
168+
virtual size_t phiNeighborSize() const { return 0; }
169+
virtual size_t phiFaceNeighborSize() const { return 0; }
170+
virtual size_t phiLowerSize() const { return 0; }
171+
///@}
172+
173+
protected:
174+
std::vector<dof_id_type> _no_dofs;
175+
};

‎src/variables/MooseFFTVariable.C

+21
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
/**********************************************************************/
2+
/* DO NOT MODIFY THIS HEADER */
3+
/* MAGPIE - Mesoscale Atomistic Glue Program for Integrated Execution */
4+
/* */
5+
/* Copyright 2017 Battelle Energy Alliance, LLC */
6+
/* ALL RIGHTS RESERVED */
7+
/**********************************************************************/
8+
9+
#include <MooseFFTVariable.h>
10+
11+
InputParameters
12+
MooseFFTVariable::validParams()
13+
{
14+
InputParameters params = MooseVariableFEBase::validParams();
15+
return params;
16+
}
17+
18+
MooseFFTVariable::MooseFFTVariable(const InputParameters & parameters)
19+
: MooseVariableFEBase(parameters)
20+
{
21+
}

0 commit comments

Comments
 (0)