Flow123d  jenkins-Flow123d-windows32-release-multijob-51
Public Member Functions | List of all members
BCField< spacedim, Value > Class Template Reference

#include <field.hh>

Inheritance diagram for BCField< spacedim, Value >:
Inheritance graph
[legend]
Collaboration diagram for BCField< spacedim, Value >:
Collaboration graph
[legend]

Public Member Functions

 BCField ()
 
- Public Member Functions inherited from Field< spacedim, Value >
 Field ()
 
 Field (const string &name, bool bc=false)
 
 Field (const Field &other)
 
Fieldoperator= (const Field &other)
 
IT::AbstractRecordget_input_type () override
 
auto disable_where (const Field< spacedim, typename FieldValue< spacedim >::Enum > &control_field, const vector< FieldEnum > &value_list) -> Field &
 
void set_mesh (const Mesh &mesh) override
 
bool is_constant (Region reg) override
 
void set_field (const RegionSet &domain, FieldBasePtr field, double time=0.0)
 
void set_field (const RegionSet &domain, const Input::AbstractRecord &a_rec, double time=0.0)
 
void set_limit_side (LimitSide side) override
 
bool set_time (const TimeGovernor &time) override
 
void copy_from (const FieldCommon &other) override
 
void output (OutputTime *stream) override
 
FieldResult field_result (ElementAccessor< spacedim > &elm) const
 
virtual Value::return_type const & value (const Point &p, const ElementAccessor< spacedim > &elm) const
 
virtual void value_list (const std::vector< Point > &point_list, const ElementAccessor< spacedim > &elm, std::vector< typename Value::return_type > &value_list) const
 
- Public Member Functions inherited from FieldCommon
 TYPEDEF_ERR_INFO (EI_Time, double)
 
 TYPEDEF_ERR_INFO (EI_Field, std::string)
 
 DECLARE_INPUT_EXCEPTION (ExcNonascendingTime,<< "Non-ascending time: "<< EI_Time::val<< " for field "<< EI_Field::qval<< ".\n")
 
 DECLARE_INPUT_EXCEPTION (ExcMissingDomain,<< "Missing domain specification (region, r_id, or r_set) in the field descriptor:")
 
 DECLARE_EXCEPTION (ExcFieldMeshDifference,<< "Two copies of the field "<< EI_Field::qval<< "call set_mesh with different arguments.\n")
 
FieldCommonname (const string &name)
 
FieldCommondescription (const string &description)
 
FieldCommoninput_default (const string &input_default)
 
FieldCommonunits (const UnitSI &units)
 Set basic units of the field. More...
 
FieldCommoninput_selection (const Input::Type::Selection *element_selection)
 
FieldCommonoutput_type (OutputTime::DiscreteSpace rt)
 
FieldCommonflags (FieldFlag::Flags::Mask mask)
 
FieldCommonflags_add (FieldFlag::Flags::Mask mask)
 
void set_n_components (unsigned int n_comp)
 
void set_input_list (const Input::Array &list)
 
const std::string & input_name () const
 
const std::string & name () const
 
const std::string description () const
 
const std::string & input_default () const
 
const UnitSIunits () const
 
OutputTime::DiscreteSpace output_type () const
 
bool is_bc () const
 
unsigned int n_comp () const
 
const Meshmesh () const
 
LimitSide limit_side () const
 
FieldFlag::Flagsflags ()
 
double time () const
 
void mark_input_times (TimeMark::Type mark_type)
 
bool changed () const
 
virtual ~FieldCommon ()
 

Additional Inherited Members

- Public Types inherited from Field< spacedim, Value >
typedef FieldAlgorithmBase
< spacedim, Value > 
FieldBaseType
 
typedef std::shared_ptr
< FieldBaseType
FieldBasePtr
 
typedef FieldAlgorithmBase
< spacedim, Value >::Point 
Point
 
- Static Public Member Functions inherited from Field< spacedim, Value >
static FieldBasePtr read_field_descriptor (Input::Record rec, const FieldCommon &field)
 
- Static Public Member Functions inherited from FieldCommon
static IT::Record field_descriptor_record (const string &record_name)
 
- Public Attributes inherited from Field< spacedim, Value >
FieldBasePtr(* read_field_descriptor_hook )(Input::Record rec, const FieldCommon &field)
 
- Static Public Attributes inherited from Field< spacedim, Value >
static constexpr bool is_enum_valued = boost::is_same<typename Value::element_type, FieldEnum>::value
 
static const unsigned int space_dim = spacedim
 
- Protected Types inherited from Field< spacedim, Value >
typedef pair< double,
FieldBasePtr
HistoryPoint
 Pair: time, pointer to FieldBase instance. More...
 
typedef boost::circular_buffer
< HistoryPoint
RegionHistory
 Nearest history of one region. More...
 
typedef Field< spacedim,
typename FieldValue< spacedim >
::Enum > 
ControlField
 
- Protected Types inherited from FieldCommon
enum  TimeStatus { TimeStatus::changed, TimeStatus::constant, TimeStatus::unknown }
 
- Protected Member Functions inherited from Field< spacedim, Value >
IT::AbstractRecord make_input_tree ()
 -------— end helper function template More...
 
void update_history (const TimeGovernor &time)
 
void check_initialized_region_fields_ ()
 
- Protected Member Functions inherited from FieldCommon
 FieldCommon ()
 
 FieldCommon (const FieldCommon &other)
 
void set_history_changed ()
 
- Protected Attributes inherited from Field< spacedim, Value >
std::shared_ptr< SharedDatadata_
 
std::shared_ptr< ControlFieldno_check_control_field_
 
std::vector< FieldBasePtrregion_fields_
 
- Protected Attributes inherited from FieldCommon
std::string name_
 
std::shared_ptr< SharedDatashared_
 
LimitSide limit_side_
 
TimeStatus set_time_result_
 Status of history. More...
 
double last_time_ = -numeric_limits<double>::infinity()
 
OutputTime::DiscreteSpace type_of_output_data_ = OutputTime::ELEM_DATA
 
FieldFlag::Flags flags_ = FieldFlag::declare_input & FieldFlag::equation_input & FieldFlag::allow_output
 Field flags. Default setting is "an equation input field, that can read from user input, and can be written to output". More...
 
- Static Protected Attributes inherited from FieldCommon
static const unsigned int history_length_limit_ =3
 

Detailed Description

template<int spacedim, class Value>
class BCField< spacedim, Value >

Same as Field<...> but for boundary regions.

Definition at line 277 of file field.hh.

Constructor & Destructor Documentation

template<int spacedim, class Value>
BCField< spacedim, Value >::BCField ( )
inline

Definition at line 279 of file field.hh.


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