Commit 8cea1f3a authored by Jason M. Gates's avatar Jason M. Gates
Browse files

Panzer: Create ZeroContributedField Evaluator

Create an `Evaluator` for the sake of initializing a contributed field
to zero.
parent 410cdbcd
// @HEADER
// ***********************************************************************
//
// Panzer: A partial differential equation assembly
// engine for strongly coupled complex multiphysics systems
// Copyright (2011) Sandia Corporation
//
// Under the terms of Contract DE-AC04-94AL85000 with Sandia Corporation,
// the U.S. Government retains certain rights in this software.
//
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions are
// met:
//
// 1. Redistributions of source code must retain the above copyright
// notice, this list of conditions and the following disclaimer.
//
// 2. Redistributions in binary form must reproduce the above copyright
// notice, this list of conditions and the following disclaimer in the
// documentation and/or other materials provided with the distribution.
//
// 3. Neither the name of the Corporation nor the names of the
// contributors may be used to endorse or promote products derived from
// this software without specific prior written permission.
//
// THIS SOFTWARE IS PROVIDED BY SANDIA CORPORATION "AS IS" AND ANY
// EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
// IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
// PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL SANDIA CORPORATION OR THE
// CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
// EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
// PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
// PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
// LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
// NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
// SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
//
// Questions? Contact Roger P. Pawlowski (rppawlo@sandia.gov) and
// Eric C. Cyr (eccyr@sandia.gov)
// ***********************************************************************
// @HEADER
///////////////////////////////////////////////////////////////////////////////
//
// Include Files
//
///////////////////////////////////////////////////////////////////////////////
// Panzer
#include "PanzerDiscFE_config.hpp"
#include "Panzer_ExplicitTemplateInstantiation.hpp"
#include "Panzer_ZeroContributedField.hpp"
#include "Panzer_ZeroContributedField_impl.hpp"
///////////////////////////////////////////////////////////////////////////////
//
// Instantiate the class.
//
///////////////////////////////////////////////////////////////////////////////
PANZER_INSTANTIATE_TEMPLATE_CLASS_TWO_T(panzer::ZeroContributedField)
// @HEADER
// ***********************************************************************
//
// Panzer: A partial differential equation assembly
// engine for strongly coupled complex multiphysics systems
// Copyright (2011) Sandia Corporation
//
// Under the terms of Contract DE-AC04-94AL85000 with Sandia Corporation,
// the U.S. Government retains certain rights in this software.
//
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions are
// met:
//
// 1. Redistributions of source code must retain the above copyright
// notice, this list of conditions and the following disclaimer.
//
// 2. Redistributions in binary form must reproduce the above copyright
// notice, this list of conditions and the following disclaimer in the
// documentation and/or other materials provided with the distribution.
//
// 3. Neither the name of the Corporation nor the names of the
// contributors may be used to endorse or promote products derived from
// this software without specific prior written permission.
//
// THIS SOFTWARE IS PROVIDED BY SANDIA CORPORATION "AS IS" AND ANY
// EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
// IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
// PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL SANDIA CORPORATION OR THE
// CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
// EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
// PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
// PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
// LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
// NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
// SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
//
// Questions? Contact Roger P. Pawlowski (rppawlo@sandia.gov) and
// Eric C. Cyr (eccyr@sandia.gov)
// ***********************************************************************
// @HEADER
#ifndef PANZER_ZEROCONTRIBUTEDFIELD_HPP
#define PANZER_ZEROCONTRIBUTEDFIELD_HPP
///////////////////////////////////////////////////////////////////////////////
//
// Include Files
//
///////////////////////////////////////////////////////////////////////////////
// Panzer
#include "Panzer_Evaluator_WithBaseImpl.hpp"
// Phalanx
#include "Phalanx_Evaluator_Derived.hpp"
#include "Phalanx_MDField.hpp"
namespace panzer
{
/**
* \brief Build a field using a specified data layout, and set it to zero.
*
* Used to initialize a field to zero before other `Evaluator`s contribute
* to it.
*/
template<typename EvalT, typename Traits>
class ZeroContributedField
:
public panzer::EvaluatorWithBaseImpl<Traits>,
public PHX::EvaluatorDerived<EvalT, Traits>
{
public:
/**
* \brief Constructor.
*
* Given the field name and layout, create the field to be initialized
* to zero.
*
* \param[in] fieldName The name of the field to be initialized to zero.
* \param[in] layout The data layout to use when creating the field.
*/
ZeroContributedField(
const std::string& fieldName,
PHX::DataLayout& layout);
/**
* \brief Evaluate the field.
*
* Set the field to zero.
*/
void
evaluateFields(
typename Traits::EvalData d) override;
private:
/**
* \brief The scalar data type.
*/
using ScalarT = typename EvalT::ScalarT;
/**
* \brief The field being initialized to zero.
*/
PHX::MDField<ScalarT> field_;
}; // end of class ZeroContributedField
} // end of namespace panzer
#endif // PANZER_ZEROCONTRIBUTEDFIELD_HPP
// @HEADER
// ***********************************************************************
//
// Panzer: A partial differential equation assembly
// engine for strongly coupled complex multiphysics systems
// Copyright (2011) Sandia Corporation
//
// Under the terms of Contract DE-AC04-94AL85000 with Sandia Corporation,
// the U.S. Government retains certain rights in this software.
//
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions are
// met:
//
// 1. Redistributions of source code must retain the above copyright
// notice, this list of conditions and the following disclaimer.
//
// 2. Redistributions in binary form must reproduce the above copyright
// notice, this list of conditions and the following disclaimer in the
// documentation and/or other materials provided with the distribution.
//
// 3. Neither the name of the Corporation nor the names of the
// contributors may be used to endorse or promote products derived from
// this software without specific prior written permission.
//
// THIS SOFTWARE IS PROVIDED BY SANDIA CORPORATION "AS IS" AND ANY
// EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
// IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
// PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL SANDIA CORPORATION OR THE
// CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
// EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
// PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
// PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
// LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
// NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
// SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
//
// Questions? Contact Roger P. Pawlowski (rppawlo@sandia.gov) and
// Eric C. Cyr (eccyr@sandia.gov)
// ***********************************************************************
// @HEADER
#ifndef PANZER_ZEROCONTRIBUTEDFIELD_IMPL_HPP
#define PANZER_ZEROCONTRIBUTEDFIELD_IMPL_HPP
namespace panzer
{
/////////////////////////////////////////////////////////////////////////////
//
// Constructor
//
/////////////////////////////////////////////////////////////////////////////
template<typename EvalT, typename Traits>
ZeroContributedField<EvalT, Traits>::
ZeroContributedField(
const std::string& fieldName,
PHX::DataLayout& layout)
{
using PHX::MDField;
using Teuchos::rcpFromRef;
field_ = MDField<ScalarT>(fieldName, rcpFromRef(layout));
this->addEvaluatedField(field_);
this->setName("ZeroContributedField: " + field_.fieldTag().identifier());
} // end of Constructor
/////////////////////////////////////////////////////////////////////////////
//
// evaluateFields()
//
/////////////////////////////////////////////////////////////////////////////
template<typename EvalT, typename Traits>
void
ZeroContributedField<EvalT, Traits>::
evaluateFields(
typename Traits::EvalData /* d */)
{
field_.deep_copy(ScalarT(0.0));
} // end of evaluateFields()
} // end of namespace panzer
#endif // PANZER_ZEROCONTRIBUTEDFIELD_IMPL_HPP
......@@ -60,6 +60,7 @@
#include "Panzer_ScalarToVector.hpp"
#include "Panzer_Sum.hpp"
#include "Panzer_Constant.hpp"
#include "Panzer_ZeroContributedField.hpp"
#include "user_app_Convection.hpp"
// ***********************************************************************
......@@ -128,6 +129,7 @@ buildAndRegisterEquationSetEvaluators(PHX::FieldManager<panzer::Traits>& fm,
using panzer::IntegrationRule;
using panzer::Integrator_BasisTimesScalar;
using panzer::Traits;
using panzer::ZeroContributedField;
using PHX::Evaluator;
using std::string;
using std::vector;
......@@ -144,6 +146,16 @@ buildAndRegisterEquationSetEvaluators(PHX::FieldManager<panzer::Traits>& fm,
RCP<IntegrationRule> ir = this->getIntRuleForDOF(dof_names[0]);
RCP<BasisIRLayout> basis = this->getBasisIRLayoutForDOF(dof_names[0]);
// Initialize the residual to zero.
for (int i(0); i < dimension_; ++i)
{
string fieldName("RESIDUAL_" + dof_names[i]);
auto layout = ir->dl_scalar;
RCP<Evaluator<Traits>> op =
rcp(new ZeroContributedField<EvalT, Traits>(fieldName, *layout));
this->template registerEvaluator<EvalT>(fm, op);
} // end loop over dimension_
// Transient Operator
if (this->buildTransientSupport())
{
......@@ -169,7 +181,7 @@ buildAndRegisterEquationSetEvaluators(PHX::FieldManager<panzer::Traits>& fm,
valName("NODE_VELOCITY_" + coord_names[i]);
double multiplier(-1);
RCP<Evaluator<Traits>> op = rcp(new
Integrator_BasisTimesScalar<EvalT, Traits>(EvaluatorStyle::EVALUATES,
Integrator_BasisTimesScalar<EvalT, Traits>(EvaluatorStyle::CONTRIBUTES,
resName, valName, *basis, *ir, multiplier));
this->template registerEvaluator<EvalT>(fm, op);
}
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment